GET
/
identity
/
accounts
List Accounts
curl --request GET \
  --url https://api.paxos.com/v2/identity/accounts \
  --header 'Authorization: Bearer <token>'
{
  "next_page_cursor": "<string>",
  "items": [
    {
      "id": "<string>",
      "identity_id": "<string>",
      "description": "<string>",
      "admin_disabled": true,
      "user_disabled": true,
      "metadata": {},
      "ref_id": "<string>",
      "members": [
        {
          "identity_id": "<string>",
          "type": "BENEFICIAL_OWNER",
          "roles": [
            "BENEFICIAL_OWNER"
          ],
          "id": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "summary_status": "PENDING",
      "updated_at": "2023-11-07T05:31:56Z",
      "profile_id": "<string>",
      "type": "BROKERAGE"
    }
  ]
}
OAuth Scope
identity:read_account

Authorizations

​
Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

​
page_cursor
string
​
order
enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

Available options:
DESC,
ASC
​
order_by
enum<string>

The specific method by which the returned results will be ordered.

Available options:
CREATED_AT
​
limit
integer

Number of results to return.

​
created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
identity_id
string

Optionally filter by primary identity identity.

​
updated_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

Response

200 - application/json

A successful response.

​
next_page_cursor
string

Cursor token required for fetching the next page.

​
items
object[]

The result list of accounts.