Skip to main content
GET
List payees

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Query Parameters

limit
integer
default:20

How many to return.

Required range: 1 <= x <= 100
starting_after
string

The last id of the previous page. Returns the items after it.

status
enum<string>
  • invited: created; hasn't signed up yet.
  • details_pending: signed up; hasn't sent bank details yet.
  • verifying: details sent; checks are running.
  • active: can be paid.
  • inactive: can't be paid.
Available options:
invited,
details_pending,
verifying,
active,
inactive
Example:

"invited"

email
string

An exact match, to find a payee you already created.

Example:

"maria@example.com"

Response

Payees, newest first.

data
object[]
required
has_more
boolean
required
Example:

false