Skip to main content
GET
/
recipients
cURL
curl --request GET \
  --url https://sandbox.onconsul.com/v1/recipients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "email": "jsmith@example.com",
      "id": "<string>",
      "on_platform": true,
      "nickname": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onconsul.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns a paginated list of recipients. Recipients are the people or businesses you send payouts to, each identified by an email address.

Authorizations

Authorization
string
header
required

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

Query Parameters

page_size
integer<int64>
cursor
string

Response

OK

data
object[]
required
next_cursor
string