Skip to main content
List the provider’s suppliers

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as group.kind. id is always returned. Fields: id, name, code, group.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096

Matches the id, name or code.

Required string length: 1 - 200

Response

One page.

data
object[]
required
Maximum array length: 100
next_cursor
string | null
required
fetched_at
string<date-time> | null
required

When this list was read from the provider. Null until a refresh completes, and again after the credentials change.

refresh_status
enum<string>
required

failed: the latest refresh did not produce a list; data is the last good one.

Available options:
idle,
running,
failed
refresh_failure
enum<string> | null
required
Available options:
not_supported,
invalid_credentials,
provider_unavailable,
start_failed,
null