GET
/
profiles
List Profiles
curl --request GET \
  --url https://api.paxos.com/v2/profiles \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "1a763ac5-13d9-4568-bb8b-747c416b105c",
      "nickname": "default",
      "type": "DEFAULT"
    },
    {
      "id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
      "nickname": "MyProfileName",
      "type": "NORMAL"
    }
  ]
}

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

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

​
limit
integer

Number of results to return.

​
order
enum<string>

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

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

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

Available options:
CREATED_AT
​
page_cursor
string

Cursor token for fetching the next page.

​
nickname
string

Optionally filter by Profile display name. Retrieves nickname(s) based on the beginning characters of the given display name (prefix matching). Case insensitive. WIldcards and regular expressions not supported.

​
ids
string[]

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

Response

200 - application/json

A successful response.

The response is of type object.