Skip to main content
GET
/
partners
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "company_name": "<string>",
      "sales_amount": 1073741823,
      "partner_type": "customer",
      "email": "jsmith@example.com",
      "frequency": "<string>",
      "payment_terms": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "invitation_status": "invited",
      "guest_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Query Parameters

​
partner_types
enum<string>[]
required
Minimum array length: 1
Available options:
customer,
supplier
​
partner_ids
string<uuid>[] | null
​
search_field
enum<string>
default:company_name
Available options:
company_name,
email
​
search_text
string | null
Required string length: 1 - 255
​
invitation_statuses
enum<string>[] | null
Available options:
invited,
accepted
​
order_by
enum<string>
default:company_name
Available options:
company_name,
sales_amount,
partner_type,
email,
frequency,
payment_terms
​
order_dir
enum<string>
default:asc
Available options:
asc,
desc
​
limit
integer
required
Required range: x <= 100
​
offset
integer
required
Required range: x >= 0

Response

Successful Response

​
items
OrganizationPartner · object[]
required
​
total_items
integer
required
Required range: x >= 0