Cortex Docs
API ReferenceUser Endpoints

User/ Profile

User profile management endpoints.

GET
/api/user/profile/v1

Authorization

user-access-token
AuthorizationBearer <token>

User access token. In Apidog use token value {{user_access_token}}.

In: header

Header Parameters

env?string

Environment override (use "test" to bypass payload encryption)

Default"test"
timezone?string

Client timezone

Default"UTC"
device?string

Client device type/details

Default"ios"
Accept-Language?string

Client language/locale preference

Default"en"
Authorization*string

Requires the user access token generated by the login or refresh endpoint. Apidog value: Bearer {{user_access_token}}.

Default"Bearer {{user_access_token}}"

Response Body

application/json

curl -X GET "https://example.com/api/user/profile/v1" \  -H "env: test" \  -H "timezone: UTC" \  -H "device: ios" \  -H "Accept-Language: en" \  -H "Authorization: Bearer {{user_access_token}}"
{  "code": "string",  "response": {    "_id": "string",    "loginType": "email",    "email": "string",    "profile": {      "name": "string",      "locale": "en",      "timezone": "utc",      "currency": "usd"    },    "twoFactor": {},    "onboardingCompleted": true  }}
PATCH
/api/user/profile/v1

Authorization

user-access-token
AuthorizationBearer <token>

User access token. In Apidog use token value {{user_access_token}}.

In: header

Header Parameters

env?string

Environment override (use "test" to bypass payload encryption)

Default"test"
timezone?string

Client timezone

Default"UTC"
device?string

Client device type/details

Default"ios"
Accept-Language?string

Client language/locale preference

Default"en"
Authorization*string

Requires the user access token generated by the login or refresh endpoint. Apidog value: Bearer {{user_access_token}}.

Default"Bearer {{user_access_token}}"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/user/profile/v1" \  -H "env: test" \  -H "timezone: UTC" \  -H "device: ios" \  -H "Accept-Language: en" \  -H "Authorization: Bearer {{user_access_token}}" \  -H "Content-Type: application/json" \  -d '{}'
{  "code": "string",  "response": {    "_id": "string",    "loginType": "email",    "email": "string",    "profile": {      "name": "string",      "locale": "en",      "timezone": "utc",      "currency": "usd"    },    "twoFactor": {},    "onboardingCompleted": true  }}
DELETE
/api/user/profile/v1

Authorization

user-access-token
AuthorizationBearer <token>

User access token. In Apidog use token value {{user_access_token}}.

In: header

Header Parameters

env?string

Environment override (use "test" to bypass payload encryption)

Default"test"
timezone?string

Client timezone

Default"UTC"
device?string

Client device type/details

Default"ios"
Accept-Language?string

Client language/locale preference

Default"en"
Authorization*string

Requires the user access token generated by the login or refresh endpoint. Apidog value: Bearer {{user_access_token}}.

Default"Bearer {{user_access_token}}"

Response Body

application/json

curl -X DELETE "https://example.com/api/user/profile/v1" \  -H "env: test" \  -H "timezone: UTC" \  -H "device: ios" \  -H "Accept-Language: en" \  -H "Authorization: Bearer {{user_access_token}}"
{  "code": "string",  "message": "string"}