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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId

Type: integer

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

Query parameters

Name	Description
orderBy	Type: string Вид сортировки. id: По идентификатору. name: По названию. Default: `id` Enum: `id`, `name`
page	Type: integer Номер страницы ответа. Значение по умолчанию — `1`.
parentId	Type: integer Идентификатор родительского подразделения. Если не указан, то выводятся все подразделения организации.
perPage	Type: integer Количество подразделений на одной странице ответа. Значение по умолчанию — `10`.

Responses

200 OK

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

Body

application/json

{
  "departments": [
    {
      "id": 0,
      "name": "example",
      "parentId": 0,
      "description": "example",
      "createdAt": "2025-01-01T00:00:00Z",
      "externalId": "example",
      "label": "example",
      "email": "example",
      "emailId": "example",
      "membersCount": 0,
      "aliases": [
        "example"
      ]
    }
  ],
  "page": 0,
  "pages": 0,
  "perPage": 0,
  "total": 0
}

Name	Description
departments	Type: v1Department[] Список подразделений. Example `[ { "id": 0, "name": "example", "parentId": 0, "description": "example", "createdAt": "2025-01-01T00:00:00Z", "externalId": "example", "label": "example", "email": "example", "emailId": "example", "membersCount": 0, "aliases": [ "example" ] } ]`
page	Type: integer Номер страницы ответа.
pages	Type: integer Количество страниц ответа.
perPage	Type: integer Количество подразделений на одной странице ответа.
total	Type: integer Общее количество подразделений.

v1Department

Name	Description
aliases	Type: string[] Алиасы почтовых рассылок. Example `[ "example" ]`
createdAt	Type: string<date-time> Дата и время создания подразделения. Example: `2025-01-01T00:00:00Z`
description	Type: string Описание подразделения. Example: `example`
email	Type: string Адрес почтовой рассылки подразделения. Example: `example`
emailId	Type: string<uint64> Идентификатор почтовой рассылки подразделения. Example: `example`
externalId	Type: string Произвольный внешний идентификатор подразделения. Example: `example`
id	Type: integer Идентификатор подразделения.
label	Type: string Имя почтовой рассылки подразделения. Например, для адреса `new-department@ваш-домен.ru` имя почтовой рассылки — это `new-department`. Example: `example`
membersCount	Type: integer Количество сотрудников подразделения с учетом вложенных подразделений.
name	Type: string Название подразделения. Example: `example`
parentId	Type: integer Идентификатор родительского подразделения.

Example

{
  "id": 0,
  "name": "example",
  "parentId": 0,
  "description": "example",
  "createdAt": "2025-01-01T00:00:00Z",
  "externalId": "example",
  "label": "example",
  "email": "example",
  "emailId": "example",
  "membersCount": 0,
  "aliases": [
    "example"
  ]
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

Была ли статья полезна?

Обзор

Создать подразделение