Get PlatformUser by ID

Retrieves a single PlatformUser by its unique identifier. Platform users represent user accounts in Kodexa.

GET /api/users/{id}

Get PlatformUser by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/users/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "active": true,
  "bio": "<string>",
  "businessGroup": "<string>",
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "firstName": "<string>",
  "groupsJson": "<string>",
  "id": "<string>",
  "image": "<string>",
  "isExternallyManaged": true,
  "lastName": "<string>",
  "preferences": {
    "showOnboarding": true,
    "showScrollbars": true,
    "showWelcomeMessage": true
  },
  "rolesJson": "<string>",
  "searchText": "<string>",
  "security": {
    "roles": [
      "<string>"
    ]
  },
  "showDeveloperTools": true,
  "title": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "userStorage": {
    "favoriteLinks": [
      {
        "link": "<string>"
      }
    ]
  },
  "userType": "<string>",
  "uuid": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Response

200

application/json

The PlatformUser

A platform user represents a user account in the Kodexa platform.

active · boolean

bio · string

businessGroup · string

changeSequence · integer<int32>

Optimistic locking version number.

createdOn · string<date-time>

Timestamp when the user was created.

email · string

firstName · string

groupsJson · string

id · string

Unique identifier (UUID) for the user.

image · string

isExternallyManaged · boolean

lastName · string

preferences · object

Show child attributes

rolesJson · string

searchText · string

security · object

Show child attributes

showDeveloperTools · boolean

title · string

updatedOn · string<date-time>

Timestamp when the user was last updated.

userStorage · object

Show child attributes

userType · string

uuid · string

Secondary UUID identifier.