Skip to navigation
Vendor/ Customer APIsPartner

List users in a partner

View as MarkdownOpen in Claude

Returns everyone inside a partner company, paginated. The partner must already be connected to your vendor account.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

partnerIdlongRequired
ID of the partner whose users to list.

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page number.

perPageintegerOptionalDefaults to 20
Number of results per page.
sortByenumOptionalDefaults to id

Field to sort results by. Any value outside the listed set falls back to id rather than returning an error.

Response

Partner users retrieved successfully.
successbooleanOptional
messagestring or nullOptional
dataobjectOptional
timestampdatetimeOptional

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error