Skip to main content
GET
cURL
Returns partnerships for the authenticated brand.
cURL
Authenticate with the API key in the playground, or send an OAuth access token in Authorization. See Authentication.

Headers

string
The platform UUID we assigned to your integration. Omit this header when we have not assigned one.

Query parameters

string
default:"active"
Partnership status. One of active, inviteSent, inviteReceived, declined, or removed. When omitted, active partners are returned. A declined filter also includes partnerships that were later removed. Those rows come back with status removed.
integer
default:"1"
1-based page number. See Pagination.
integer
default:"50"
Items per page. Maximum 100.

Response

object[]
required
Partners on this page.
integer
required
Total partners matching the status filter, across all pages.

Errors