API
API StatusGet API KeysBlogHelp Center

List Payees

get
https://au-api.basiq.io/users//payees

Retrieves a paginated list of payees for a specific user. Supports filtering by payee type, connection ID, and creation date.

Path Params
uuid
required

The unique identifier of the user.

Query Params
integer
1 to 500
Defaults to 25

The maximum number of payees to return per page. Valid values are 1-500. Default is 25.

string

Filter expression to narrow down results. Supports the following filters:

  • type.eq('value') - Filter by payee type (domestic, biller, international, digitalWallet)
  • connectionId.eq('value') - Filter by connection ID
  • created.bt('startDate','endDate') - Filter by creation date range
  • created.gt('date') - Filter by creation date greater than
  • created.gteq('date') - Filter by creation date greater than or equal
  • created.lt('date') - Filter by creation date less than
  • created.lteq('date') - Filter by creation date less than or equal
  • created.eq('date') - Filter by creation date equal to
Responses

Updated about 2 months ago

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

Updated about 2 months ago

Basiq Pty Ltd (ABN 95 616 592 011) is a wholly-owned but non-guaranteed subsidiary of Cuscal Limited (ABN 95 087 822 455).
Basiq Pty Ltd is an accredited data recipient under the Consumer Data Right (accr. # ADRBNK000208) and is not an authorised deposit-taking institution.
Contact Us
© 2025 Basiq Pty Ltd