v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB

Users

Search Users

Endpoint to find Users using filtering parameters.

get/business/v2/employees

Query parameters

customreferenceIdstring

The reference of the User in an external system.

Example:IDEMPLOY111

The reference of the User in an external system.

namestring

The name of the User.

Example:John

The name of the User.

surnamestring

The surname of the User.

Example:Doe

The surname of the User.

visibleboolean

The visibility property of the User.

Example:true

The visibility property of the User.

jobTitlestring

The job title of the User.

Example:HR Specialist

The job title of the User.

departmentstring

The department of the User.

Example:HR departement

The department of the User.

emailstring

The email address of the User.

Example:johndoe@email.com

The email address of the User.

mobilestring

The mobile number of the User.

Example:johndoe@email.com

The mobile number of the User.

The status of the User.

idstring

The ID of the User.

Example:XMPL1234-000001

The ID of the User.

groupIdstring

The ID of the Group the User is a member of.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa

The ID of the Group the User is a member of.

reportsTostring[]

The IDs of the User resources to which they could report to.

[
  "XMPL1234-000001",
  "XMPL1234-000002",
  "XMPL1234-000003"
]

workStatusWorkStatus[]

Filters users by their work status.

expensePolicyIdstring[]

The IDs of the ExpensePolicy resources to search for.

[
  "XMPL1234-000001",
  "XMPL1234-000002",
  "XMPL1234-000003"
]

excludeExpensePolicyIdstring[]

The IDs of the ExpensePolicy resources to exclude. User resources with no ExpensePolicy assigned will be excluded.

[
  "XMPL1234-000001",
  "XMPL1234-000002",
  "XMPL1234-000003"
]

withoutExpensePolicyboolean

Whether to search for User resources with no ExpensePolicy assigned.

Example:true

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result array contains Users.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "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",
      "custom_reference_id": "123456-user-1",
      "visible": true,
      "groups": [
        "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
      ],
      "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"
    }
  ]
}