Get Profile

Read a single profile by its UUID, or read the default profile using the alias “default”.

GET /profiles/{profile_id}

Get Profile

cURL

curl --request GET \
  --url https://api.paxos.com/v2/profiles/{profile_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "nickname": "MyProfileName",
  "type": "NORMAL"
}

OAuth Scope

funding:read_profile

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 →

Path Parameters

profile_id · string · required

The UUID of the profile, or "default" for the default profile.

Query Parameters

include_deactivated · boolean

Used to include deactivated profiles in the response.

Response

200 - application/json

A successful response.

id · string · required

nickname · string · required

type · enum<string> · required

The profile type.

• NORMAL: A client-created profile. All Profiles created using the CreateProfile endpoint are of this type.
• DEFAULT: A system-generated profile.

Available options: NORMAL, DEFAULT

description · string

account_id · string