List Referrals

Retrieve a paginated list of referrals for a partner account with optional filtering and sorting. Supports filtering by various fields including CRM ID, cloud ID, status, dates, and more.

Path Params
uuid
required

UUID of the partner account

Query Params
integer
≥ 1
Defaults to 1

Page number (starts from 1)

integer
1 to 100
Defaults to 20

Number of records per page

string

Filter by cloud object ID (ace_id for AWS partners)

string

Filter by CRM object ID

string
enum

Filter by form status

Allowed:
string

Filter by object ID

string
enum

Filter by object type

Allowed:
string

Filter by company name

string
enum

Filter by who referred

Allowed:
string
enum
Defaults to updated_at

Field to sort by

Allowed:
string
enum
Defaults to desc

Sort order

Allowed:
string

Cloud approval status (comma-separated for multiple)

string

Partner acceptance status (comma-separated for multiple, 'Pending' matches null)

string

Stage filter (comma-separated for multiple)

date

Filter records with target close date between today and this date (YYYY-MM-DD)

date

Filter records updated after this date (YYYY-MM-DD)

string

Parent object ID (Deal ID for HubSpot, Opportunity ID for Salesforce)

Responses

401

Unauthorized - invalid or missing token

500

Internal server error

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json