Skip to main content
GET
/
payouts
/
{id}
/
items
cURL
curl --request GET \
  --url https://sandbox.onconsul.com/v1/payouts/{id}/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "amount": "<string>",
      "email": "jsmith@example.com",
      "id": "<string>",
      "recipient_id": "<string>"
    }
  ],
  "next_cursor": "<string>"
}
Returns a paginated list of individual items within a payout, showing each recipient’s name, amount, and current status.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Query Parameters

​
page_size
integer<int64>
​
cursor
string

Response

OK

​
data
object[]
required
​
next_cursor
string