List payees | Root API

{
  "data": [
    {
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "country_code": "US",
      "country_sub_division": "NY",
      "city": "New York",
      "address_line": "123 Main Street, Apt 4B",
      "postal_code": "10001"
    },
    {
      "created_at": "2024-03-21T12:00:00Z",
      "updated_at": "2024-03-21T12:00:00Z",
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "name": "Jane Smith",
      "email": "jane.smith@example.com",
      "country_code": "US",
      "country_sub_division": "NY",
      "city": "New York",
      "address_line": "456 Broadway, Suite 200",
      "postal_code": "10003"
    }
  ],
  "has_more": false,
  "total_count": 2
}

Retrieves a paginated list of payees with multiple optional filtering by email, name, creation date, status etc.

Success Responses

Status Code	Description
200	OK - The list of payees was successfully retrieved

Error Responses

Status Code	Error Code	Description
400	VALIDATION_ERROR	The provided query parameters failed validation
401	AUTHENTICATION_ERROR	Authentication credentials are invalid or missing
403	AUTHORIZATION_ERROR	You do not have permission to perform this action

Retrieves a paginated list of payees with multiple optional filtering by email, name, creation date, status etc. **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK - The list of payees was successfully retrieved | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 400 | VALIDATION_ERROR | The provided query parameters failed validation | | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action |

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitinteger or nullOptional10-500Defaults to 50

Number of items to return per page. Maximum is 500.

emailstring or nullOptional

Filter payees by email (case-insensitive partial match)

namestring or nullOptional

Filter payees by name (case-insensitive partial match)

has_defaultboolean or nullOptional

Filter payees by whether they have a default payment method: true or false

created_at_gtedatetime or nullOptional

Return payees created on or after this date (YYYY-MM-DD).

created_at_ltedatetime or nullOptional

Return payees created on or before this date (YYYY-MM-DD).

orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:

Response

List of payees retrieved successfully

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null

$	curl -G https://api.useroot.com/api/payees \
>	-H "x-api-key: <apiKey>" \
>	-d limit=50 \
>	-d order=desc