Skip to main content
GET
List persons

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Path Parameters

account_id
string
required

The account to act on. It must be one of your own accounts; any other ID returns 404.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

The account's persons.

items
object[]

The account's persons for this page, oldest first, each carrying the same shape as reading one person. The order is stable, so paging with offset neither repeats nor skips anyone.

total
integer

How many persons the account has in total, not how many came back on this page. Compare it against offset plus the length of items to know whether another page is waiting.

Example:

2

limit
integer

How many persons a page returns at most, echoing the limit you sent. It defaults to 50 and is capped at 100; anything outside 1 to 100 is rejected with 422.

Example:

50

offset
integer

How many persons were skipped before this page, echoing the offset you sent. Add limit to it to ask for the next page, and stop once it reaches total.

Example:

0