List payouts

Returns a paginated list of all payouts for the authenticated company. Results can be narrowed down by campaign, payout order, recipient email, or payout type. Page requests report the total via total-count. Pass cursor to walk the same order without a total count.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter results to payouts belonging to a specific campaign

string

Filter results to payouts belonging to a specific payout order

string

Filter results to payouts issued to a specific recipient email address

string
enum

Filter results to a single payout type. Returns both types when omitted.

Allowed:
integer

Page number, starting at 1. Ignored when cursor is present.

integer

Records per page. Defaults to 10 and cannot exceed 20.

string

Opaque keyset cursor. Pass an empty value for the first page. When present, page is ignored and the response omits total-count, total-pages, and current-page. The next page token is X-Gifq-Pagination-Next-Cursor when another page exists.

Responses

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