Skip to main content
GET
List Payees

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns these payees. Omit to list every payee in your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

status
string | null

Show only payees in this state: active or archived. Omit to return all.

Example:

"active"

limit
integer
default:50

How many payees to return per page (1 to 200).

Required range: 1 <= x <= 200
offset
integer
default:0

How many payees to skip before this page starts.

Required range: x >= 0

Response

A page of payees.

status_code
integer
required

HTTP status code for the response.

data
PayeeRead · object[]
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.

row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
next_cursor
string | null

Cursor for the next page, if available.