Посмотреть список подразделений

Возвращает список подразделений с постраничной навигацией.

Примечание

Требуется разрешение на чтение данных о подразделениях.

Request

GET

https://api360.yandex.net/directory/v1/org/{orgId}/departments

Path parameters

Name

Description

orgId*

Type: integer<int64>

Идентификатор организации.

Query parameters

Name

Description

orderBy

Type: string

Вид сортировки.

  • id: По идентификатору.
  • name: По названию.

Default: id

Enum: id, name

page

Type: integer<int64>

Номер страницы ответа. Значение по умолчанию — 1.

parentId

Type: integer<int64>

Идентификатор родительского подразделения. Если не указан, то выводятся все подразделения организации.

perPage

Type: integer<int64>

Количество подразделений на одной странице ответа. Значение по умолчанию — 10.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "departments": [
        {
            "id": 0,
            "name": "string",
            "parentId": 0,
            "description": "string",
            "createdAt": "2022-12-29T18:02:01Z",
            "externalId": "string",
            "label": "string",
            "email": "string",
            "headId": "string",
            "membersCount": 0,
            "aliases": [
                "string"
            ]
        }
    ],
    "page": 0,
    "pages": 0,
    "perPage": 0,
    "total": 0
}

Name

Description

departments

Type: v1Department[]

Список подразделений.

page

Type: integer<int64>

Номер страницы ответа.

pages

Type: integer<int64>

Количество страниц ответа.

perPage

Type: integer<int64>

Количество подразделений на одной странице ответа.

total

Type: integer<int64>

Общее количество подразделений.

v1Department

Name

Description

aliases

Type: string[]

Алиасы почтовых рассылок.

createdAt

Type: string<date-time>

Дата и время создания подразделения.

description

Type: string

Описание подразделения.

email

Type: string

Адрес почтовой рассылки подразделения.

externalId

Type: string

Произвольный внешний идентификатор подразделения.

headId

Type: string<uint64>

Руководитель подразделения.

id

Type: integer<int64>

Идентификатор подразделения.

label

Type: string

Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

membersCount

Type: integer<int64>

Количество сотрудников подразделения с учетом вложенных подразделений.

name

Type: string

Название подразделения.

parentId

Type: integer<int64>

Идентификатор родительского подразделения.

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Обзор
Следующая
Создать подразделение