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

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

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

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

HTTP-запрос

GET https://api360.yandex.net/directory/v1/org/{orgId}/departments\
?page={integer}\
&perPage={integer}\
&parentId={integer}\
&orderBy={string}

Path-параметры

orgId *

integer

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

orgId *

integer

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

Query-параметры

page

integer

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

perPage

integer

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

parentId

integer

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

orderBy

string

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

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

Значение по умолчанию: id.

page

integer

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

perPage

integer

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

parentId

integer

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

orderBy

string

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

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

Значение по умолчанию: id.

Ответы

Код 200

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

{
  "departments": [
    {
      "aliases": [
        string
      ],
      "createdAt": string,
      "description": string,
      "email": string,
      "externalId": string,
      "headId": string,
      "id": integer,
      "label": string,
      "membersCount": integer,
      "name": string,
      "parentId": integer
    }
  ],
  "page": integer,
  "pages": integer,
  "perPage": integer,
  "total": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

departments[]

array

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

departments[].aliases[]

array

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

departments[].createdAt

string

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

departments[].description

string

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

departments[].email

string

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

departments[].externalId

string

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

departments[].headId

string

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

departments[].id

integer

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

departments[].label

string

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

departments[].membersCount

integer

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

departments[].name

string

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

departments[].parentId

integer

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

page

integer

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

pages

integer

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

perPage

integer

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

total

integer

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

departments[]

array

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

departments[].aliases[]

array

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

departments[].createdAt

string

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

departments[].description

string

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

departments[].email

string

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

departments[].externalId

string

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

departments[].headId

string

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

departments[].id

integer

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

departments[].label

string

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

departments[].membersCount

integer

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

departments[].name

string

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

departments[].parentId

integer

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

page

integer

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

pages

integer

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

perPage

integer

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

total

integer

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

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string