List API Credentials

List all API credentials that have been created.

GET /api-creds/credentials

Try it

List API Credentials

cURL

curl --request GET \
  --url https://api.paxos.com/v2/api-creds/credentials \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "client_id": "<string>",
      "client_public_keys": [
        {
          "algorithm": "<string>",
          "public_key": "<string>",
          "nickname": "<string>",
          "id": "<string>",
          "client_id": "<string>",
          "active": true
        }
      ],
      "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>"
      ],
      "created_by": "<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:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

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<int32>

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].

Available options: APPROVED, DISABLED

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[]

Show child attributes

items. id · string

items. customer_id · string

items. client_id · string

items. client_public_keys · object[]

Show child attributes

items.client_public_keys. algorithm · string · required

items.client_public_keys. public_key · string · required

items.client_public_keys. nickname · string · required

items.client_public_keys. id · string

items.client_public_keys. client_id · string

items.client_public_keys. active · boolean

items. status · enum<string>

Available options: APPROVED, DISABLED

items. created_at · string<date-time>

items. updated_at · string<date-time>

items. nickname · string

items. ip_allowlist · string[]

items. enforce_request_signing · boolean

items. client_scopes · string[]

items. created_by · string

next_page_cursor · string

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