Skip to main content
GET
/
api-creds
/
credentials
List API Credentials
curl --request GET \
  --url https://api.paxos.com/v2/api-creds/credentials \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "client_id": "<string>",
      "client_public_keys": [
        {
          "id": "<string>",
          "client_id": "<string>",
          "algorithm": "<string>",
          "public_key": "<string>",
          "active": true,
          "nickname": "<string>"
        }
      ],
      "status": "APPROVED",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "nickname": "<string>",
      "ip_allowlist": [
        "<string>"
      ],
      "enforce_request_signing": true,
      "client_scopes": [
        "<string>"
      ]
    }
  ],
  "next_page_cursor": "<string>"
}
OAuth Scope
api_creds:read_credentials

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

​
order
enum<string>

Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to DESC.

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

The specific field by which the returned results will be ordered. Defaults to CREATED_AT.

Available options:
CREATED_AT
​
limit
integer

The maximum number of items to return. Defaults to 0 (return all records). Max value is 1000.

​
page_cursor
string

The page cursor for pagination. Use the next_page_cursor from the response to get the next page.

​
statuses
enum<string>[]

Filter for credentials with a set of statuses. Defaults to [APPROVED].

​
ids
string[]

Optionally filter by the UUIDs of the credentials. Limit 100.

​
client_ids
string[]

Optionally filter by the client IDs of the credentials. Limit 100.

Response

200 - application/json

A successful response.

​
items
object[]
​
next_page_cursor
string

The page cursor for the next page of results. Empty if this is the last page.