List Payees
List the payees under this payer account. Supports cursor pagination. Archived payees are excluded unless you ask for them with ?status=archived.
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
the payer account this request is scoped to. Every payee, bank account, and payment lives under one payer account, so it is part of the path on all operate (Tier 1) routes.
Query parameters
token to fetch the next page of a list (the end_cursor from a previous response's page_info)
token to fetch the previous page of a list (the start_cursor from a previous response's page_info)
the number of resources to retrieve per page (default 25, max 100)
filter records created strictly after the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing
filter records created strictly before the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing
filter payees by status. Omit it and every payee except archived is returned; archiving is a soft delete, so archived payees are visible only when asked for by name.
Headers
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Response
Successfully listed payees
Example response
{
"type": "array",
"data": [
{
"id": "pe_abc123",
"type": "payee",
"payer_account_id": "payer_123xyz",
"name": "Acme Plumbing LLC",
"entity_type": "limited_liability_company",
"email": "billing@acmeplumbing.com",
"tax_id_last4": "4021",
"address": {
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA"
},
"receiving_bank_account_id": "ba_recv123",
"status": "active",
"metadata": {
"erp_payee_id": "V-4021"
},
"created_at": "2026-01-01T12:00:00Z",
"updated_at": "2026-01-01T12:00:00Z"
}
],
"page_info": {
"start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd",
"end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.