Skip to main content
List supplier directory

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.

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
Required string length: 1 - 200
sort
enum<string>
default:name
Available options:
name,
organization_number,
email
direction
enum<string>
default:asc
Available options:
asc,
desc
has_invoices
enum<string>
Available options:
true,
false
has_agreements
enum<string>
Available options:
true,
false
has_alerts
enum<string>
Available options:
true,
false

Response

Filtered directory page and total.

data
object[]
required
Maximum array length: 100
next_cursor
string | null
required
total_count
integer
required
Required range: x >= 0