Skip to main content
GET
/
v1
/
suppliers
/
accounts
Get all accounts
curl --request GET \
  --url https://api.voltview.co.uk/v1/suppliers/accounts \
  --header 'x-api-key: <api-key>'
[
  {
    "referenceId": "<string>",
    "id": "<string>",
    "reason": "<string>",
    "isTest": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

VoltView API key

Query Parameters

​
expiryDateIsLessThanOrEqualTo
string

Filter to accounts by the date

​
isTest
boolean

Filter to accounts by isTest

​
supplier
string

Filter to accounts by supplier

​
referenceId
string

Filter to accounts by referenceId

Response

Account created successfully

​
referenceId
string

Reference identifier

​
id
string

Account identifier

​
status
enum<string>

Account connection status

Available options:
PASSING,
FAILING
​
reason
string

Reason for failing

​
isTest
boolean

Test accounts are deleted after 30 days.

​
createdAt
string<date-time>

Date the account was created