Skip to main content
GET
/
v1
/
loas
List LOAs
curl --request GET \
  --url https://api.voltview.co.uk/v1/loas \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "customerName": "<string>",
    "authorizedPersonsCount": 123,
    "supplyPointsCount": 123,
    "validFrom": "2023-12-25",
    "validTo": "2023-12-25",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

VoltView API key

Query Parameters

​
status
enum<string>

Filter by LOA status

Available options:
PENDING,
SENT,
SIGNED,
EXPIRED,
REJECTED
​
limit
integer
default:50

Number of records to return (max 100)

Required range: x <= 100
​
offset
integer
default:0

Offset for pagination

Response

LOAs retrieved successfully

​
id
string

LOA identifier

​
customerName
string

Customer/business name

​
status
enum<string>

LOA status

Available options:
PENDING,
SENT,
SIGNED,
EXPIRED,
REJECTED
​
authorizedPersonsCount
integer

Number of authorized persons

​
supplyPointsCount
integer

Number of supply points

​
validFrom
string<date>

LOA validity start date

​
validTo
string<date>

LOA validity end date

​
createdAt
string<date-time>

Creation timestamp