Get UserAccount

GET

/user-accounts/{object_id}

Users

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (UserAccount)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserAccount

Example:

UserAccount

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "UserAccount",
        "attributes": {
            "hasExternalAuth": true,
            "canChangePassword": true,
            "canSetNewPassword": true,
            "shouldVerifyEmail": true,
            "name": "string",
            "emailAddress": "string",
            "profilePicture": {
                "__type": "File",
                "name": "string",
                "url": "string"
            },
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "notificationConfig": {}
        },
        "relationships": {}
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-07-08 10:51:21

Get Session Context

List UserEngagement