Получение списка сотрудников

Retrieves the collection of User resources.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page

integer

optional

The collection page number

pagination

boolean

optional

Enable or disable pagination

string

optional

name

string

optional

surname

string

optional

phone

string

optional

exists[deletedAt]

boolean

optional

fields[]

string

optional

Example:

fields[]=id

rolesCollection.id[]

integer

optional

Фильтр по роли

Example:

rolesCollection.id[]=2

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

array[object (Пользователи) {18}]

optional

integer

read-onlyoptional

>= 1

firstname

string

required

surname

string

required

Фамилия

phone

string <phone>

required

Телефон

Match pattern:

^((\+7|7|8)+([0-9]){10})$

string <email>

required

departmentCode

optional

Код подразделения (Идентификатор кода).Обязательно, если роль = "менеджер по продажам".

position

optional

Должность

group

optional

Группа пользователя

codes

array[object (Коды пользователей (users view)) {3}]

optional

Код менеджера (Уникальный код менеджера, состоящий только из букв и чисел).В поле “Код менеджера” не должно быть разрешено сохранять значение с дефисом, должна появляться ошибка.Обязательно, если роль = "Менеджер по продажам".

roles

array[object (Роли) {5}]

required

partner

object

Партнер

optional

createdAt

string <date-time>

optional

updatedAt

string <date-time>

optional

deletedAt

string <date-time> | null

optional

createdBy

object

Пользователи (base)

optional

updatedBy

object

Пользователи (base)

optional

parent

optional

Руководитель

isAdmin

boolean

optional

Default:

false

pagination

object (Pagination)

optional

first

integer

optional

>= 1

current

integer

optional

>= 1

last

integer

optional

>= 1

integer

optional

>= 1

integer

optional

>= 1

total

integer

optional

>= 0

Example

{
    "data": [
        {
            "id": 1,
            "firstname": "string",
            "surname": "string",
            "phone": "string",
            "email": "user@example.com",
            "departmentCode": {
                "deletedAt": "2019-08-24T14:15:22Z",
                "id": 1,
                "code": "string"
            },
            "position": {
                "deletedAt": "2019-08-24T14:15:22Z",
                "id": 1,
                "title": "string"
            },
            "group": {
                "deletedAt": "2019-08-24T14:15:22Z",
                "id": 1,
                "title": "string"
            },
            "codes": [
                {
                    "deletedAt": "2019-08-24T14:15:22Z",
                    "id": 1,
                    "code": "string"
                }
            ],
            "roles": [
                {
                    "deletedAt": "2019-08-24T14:15:22Z",
                    "id": 1,
                    "title": "string",
                    "allServices": true,
                    "services": [
                        {
                            "deletedAt": "2019-08-24T14:15:22Z",
                            "id": 1,
                            "title": "string",
                            "departureCountry": {
                                "deletedAt": "2019-08-24T14:15:22Z",
                                "id": 1,
                                "title": "string"
                            },
                            "departureCity": {
                                "deletedAt": "2019-08-24T14:15:22Z",
                                "id": 1,
                                "title": "string",
                                "country": {
                                    "deletedAt": "2019-08-24T14:15:22Z",
                                    "id": 1,
                                    "title": "string"
                                }
                            },
                            "isForwarding": false
                        }
                    ]
                }
            ],
            "partner": {
                "id": "string",
                "name": "string"
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "deletedAt": "2019-08-24T14:15:22Z",
            "createdBy": {
                "id": 1,
                "firstname": "string",
                "surname": "string",
                "phone": "string",
                "email": "user@example.com",
                "codes": [],
                "roles": [],
                "partner": {
                    "id": "string",
                    "name": "string"
                }
            },
            "updatedBy": {
                "id": 1,
                "firstname": "string",
                "surname": "string",
                "phone": "string",
                "email": "user@example.com",
                "codes": [],
                "roles": [],
                "partner": {
                    "id": "string",
                    "name": "string"
                }
            },
            "parent": {
                "id": 1,
                "firstname": "string",
                "surname": "string",
                "phone": "string",
                "email": "user@example.com",
                "codes": [],
                "roles": [],
                "partner": {
                    "id": "string",
                    "name": "string"
                }
            },
            "isAdmin": false
        }
    ],
    "pagination": {
        "first": 1,
        "current": 1,
        "last": 1,
        "previous": 1,
        "next": 1,
        "total": 0
    }
}

🟠400Ошибки 4XX

🔴500Ошибки 5XX