Skip to main content
GET
List deal partner roles

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Query Parameters

partner_type
enum<string>
Available options:
referral,
reseller
kind
enum<string>

Keep one list: supporting partner roles or primary partner roles. Omitted lists both.

Available options:
primary,
supporting
include_archived
boolean
default:false

Include archived roles. A role still on deals is archived instead of deleted; deals keep showing it.

Response

200 - application/json

Default Response

uuid
string
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
kind
enum<string>
required

supporting: a role for supporting partners. primary: a role for the deal's primary partner.

Available options:
primary,
supporting
label
string
required
sort_order
number
required
archived
boolean
required

Archived roles are no longer offered for new assignments.

in_use
boolean
required

Some deal carries this role (a supporting partner's role, or a primary partner role picked on the deal), so deleting it archives it instead.