latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Users

Get a user

Retrieve the details of a single user (required scope users:read)

get/v1/users/{userId}

Path parameters

userIdinteger required

The unique identifier of the user

Headers

Customer-Idinteger required

The customer identifier

Response

idinteger

The unique identifier of the user

emailstring

The email of the user

namestring

The name associated with the user

createdAtstring date-time

The date and time when the user was created

roleIdinteger

The role id associated with the user

defaultJobCategoryIdinteger nullable

The default job category id associated with the user

positionstring nullable

The job position or title associated with the user

type'active' | 'inactive' | 'integration' | 'linkedResource'

Represents the type of licence assigned to a userPossible values:<ul><li>active: Indicates an active licence</li><li>inactive: Indicates an inactive licence</li><li>integration: Indicates a licence used for system integrations</li><li>linkedResource: Indicates a licence associated with a linked resource</li></ul>

groupIdinteger nullable

The group identifier associated with the user

mobilestring nullable

The mobile phone number associated with the user

Example response

{
  "id": 123456,
  "email": "email@example.com",
  "name": "John Doe",
  "createdAt": "2023-12-01T13:00:00.0000000+00:00",
  "roleId": 12345,
  "position": "Engineer",
  "type": "active",
  "groupId": 67890,
  "mobile": "+447700900123",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}