List referrals

get

https://api.suresend.ai/api/partner/referrals

Referrals your team sent or received, newest first.

Referrals sent by email or text to someone outside Sure Send are not included.
When your team is the receiver, pending_approval and rejected referrals are
left out: they never reached you. The sender still sees its own.

meta uses the same snake_case pagination keys as the other list endpoints.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

direction

string

enum

Defaults to all

sent: referrals your team sent. received: referrals sent to your team. all (default): both. Any other value is treated as all.

Allowed:

status

string

One status, or several separated by commas (pending,accepted). Unknown values are ignored. One of: pending_approval, pending, accepted, active, closed, declined, rejected.

personId

uuid

Only referrals for this contact: your contact if you sent it, your copy if you received and accepted it.

receivingTeamId

uuid

Only referrals sent to this team.

sendingTeamId

uuid

Only referrals sent by this team.

sort

string

enum

Defaults to createdAt

Sort field. Default createdAt.

Allowed:

order

string

enum

Defaults to desc

Sort direction. Default desc.

Allowed:

page

integer

Defaults to 1

limit

integer

1 to 100

Defaults to 25

Results per page. Default 25, maximum 100.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200success

401unauthorized