Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Profiles

Get Profile

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

get/profiles/{profile_id}

Path parameters

profile_idstring required

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

Query parameters

include_deactivatedboolean

Used to include deactivated profiles in the response.

Response

A successful response.

idstring required
nicknamestring required
type'NORMAL' | 'DEFAULT' 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.
descriptionstring
account_idstring

Example response

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