XExentral
User

View user

Changed on

Returns details of a single user. To read the rights of a user, prefer GET /api/v3/users/{id}?include=moduleRights over the application/vnd.xentral.user-permissions+json variant of this endpoint: it returns the same rights alongside the user record in the v3 response format. That endpoint is currently in beta.

get/api/v1/users/{id}

Request

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

A single user resource.

Example response

{
  "data": {
    "id": "12",
    "globalUserId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "username": "Bene",
    "createdAt": "2023-08-13T14:45:36+02:00",
    "description": "This is the user description.",
    "color": "ff0000",
    "isActive": true,
    "locale": "de_DE",
    "isAdmin": true,
    "email": "ceo@example.com",
    "emailVerifiedAt": "2023-08-14T14:45:36+02:00",
    "contactId": "123",
    "isSupportUser": false
  }
}

Changes

  • ebe5ba2a4ed8Revision changes
    • info

      added the optional property / to the response with the status (media type: application/vnd.xentral.user-permissions+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/vnd.xentral.user-permissions+json)