Retrieve Partners

get

https://{APP_DOMAIN}/api/3.2/marketing/partners

Returns a paginated list of partners and affiliates with their contact details.

Query Params

integer

Filter by partner ID

name

string

Filter by name

active

boolean

Filter by active status

contact_name

string

Filter by contact name

contact_email

string

Filter by contact email

partner_categories_id

integer

Filter by partner category ID

domain

string

Filter by partner domain (relationship filter, supports array)

id_with_name

string

Search by ID or name (partial match on both)

created_at

string

Filter by creation date. Supports operators: >, >=, <, <=

updated_at

string

Filter by last updated date. Supports operators: >, >=, <, <=

columns[]

integer

The field to be included in the json response. You can have multiple columns[] query params included in the request URL.

page

integer

The page to return.

per_page

integer

The total results to return per page.

sort

string

The field to sort the request by. column_name|asc OR desc

Response

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

200The retrieved partners