Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Users

Get User

Endpoint to retrieve a specific User by ID.

get/business/v2/employees/{userId}

Path parameters

userIdstring required

The User ID.

Example:XMPL1234-000001

Response

The returned resource is a single User.

idstring

The User ID.

namestring

The name of the User (sortable: yes).

surnamestring

The surname of the User (sortable: yes).

middlenamestring

The middlename of the User (sortable: no).

dobstring

The Date of birth of the User.

job_titlestring

The job title of the User (sortable: yes).

departmentstring

The department of the User (sortable: no).

emailstring

The email address of the User (sortable: no).

mobilestring

The mobile number of the User including the country code (sortable: no).

mobile_prefixstring

The mobile number country code (sortable: no).

custom_reference_idstring

The reference of the employee in an external system (sortable: yes).

status'ACTIVE' | 'INACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'PENDING' | 'ARCHIVED'
visibleboolean

It determines whether the User is visible in the web console (sortable: yes).

mobile_accessboolean

It determines whether the User has mobile access (sortable: no).

web_accessboolean

It determines whether the User has web access (sortable: no).

groupsstring[]

The list of Groups ID the User is member of (sortable: no).

reports_tostring

The ID of the User it reports to.

contact_idstring

The ID of the Contact assigned to the User. This information can be updated from the Add Contact and Update Contact endpoints.

creation_timestring

The date and time when the User was created (sortable: yes).

last_updatestring

The date and time when the User was last updated (sortable: yes).

work_status'AVAILABLE' | 'OUT_OF_OFFICE'

Example response

{
  "id": "XMPL1234-000001",
  "name": "John",
  "surname": "Smith",
  "middlename": "John",
  "dob": "1970-10-21",
  "job_title": "Business Strategist",
  "department": "Research & Development",
  "email": "jdoe@fake.soldo.com",
  "mobile": "+44123323232",
  "mobile_prefix": "+44",
  "custom_reference_id": "123456-user-1",
  "visible": true,
  "mobile_access": true,
  "web_access": true,
  "groups": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "shipping_address": {
    "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "recipient": "JohnSmith",
    "name": "Foo Street 75",
    "line1": "Bar Street 64",
    "line2": "Other street 31",
    "country": "GB",
    "county": "LD",
    "city": "London",
    "post_code": "00000",
    "delivery_phone_number": "+441234567890",
    "type": "SHIPPING",
    "creation_time": "2017-06-01T12:48:40Z",
    "last_update": "2017-06-01T12:48:40Z"
  },
  "reports_to": "XMPL1234-000001",
  "roles": [
    {
      "id": "superAdmin",
      "name": "superAdmin",
      "description": "The SuperAdmin role",
      "scope": "ALL"
    }
  ],
  "contact_id": "135fdb6c-2e77-4fc0-a79f-2453fde75ef7",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update": "2017-06-01T12:48:40Z"
}