Skip to main content
List the provider’s companies

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Query Parameters

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 100
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