Просмотреть список групп
Возвращает список групп с постраничной навигацией.
HTTP-запрос
GET https://api360.yandex.net/directory/v1/org/{orgId}/groups\
?page={integer}\
&perPage={integer}
Path-параметры
* Обязательный параметр
Query-параметры
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество групп на одной странице ответа. Значение по умолчанию — |
page | integer Номер страницы ответа. Значение по умолчанию — |
perPage | integer Количество групп на одной странице ответа. Значение по умолчанию — |
* Обязательный параметр
Ответы
Код 200
Запрос успешно выполнен.
{ "groups": [ { "adminIds": [ string ], "aliases": [ string ], "authorId": string, "createdAt": string, "description": string, "email": string, "externalId": string, "id": integer, "label": string, "memberOf": [ integer ], "members": [ { "id": string, "type": string } ], "membersCount": integer, "name": string, "removed": boolean, "type": string } ], "page": integer, "pages": integer, "perPage": integer, "total": integer }
Скопировано
Представление
Поля
groups[] | array Список групп. |
groups[]. | array Идентификаторы руководетелей группы. |
groups[]. | array Алиасы почтовых ящиков группы. |
groups[]. | string Идентификатор создателя группы. |
groups[]. | string Дата и время создания группы. |
groups[]. | string Описание группы. |
groups[]. | string Адрес почтовой рассылки группы. |
groups[]. | string Произвольный внешний идентификатор группы. |
groups[]. | integer Идентификатор группы. |
groups[]. | string Имя почтовой рассылки группы. Например, для адреса |
groups[]. | array Идентификаторы групп, в которые входит эта группа. |
groups[]. | array Участники группы. |
groups[]. | string Идентификатор участника группы. |
groups[]. | string Тип участника группы.
Значение по умолчанию:
|
groups[]. | integer Количество участников группы. |
groups[]. | string Название группы. |
groups[]. | boolean Признак удаленной группы: |
groups[]. | string Тип группы. |
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество групп на одной странице ответа. |
total | integer Общее количество групп. |
groups[] | array Список групп. |
groups[]. | array Идентификаторы руководетелей группы. |
groups[]. | array Алиасы почтовых ящиков группы. |
groups[]. | string Идентификатор создателя группы. |
groups[]. | string Дата и время создания группы. |
groups[]. | string Описание группы. |
groups[]. | string Адрес почтовой рассылки группы. |
groups[]. | string Произвольный внешний идентификатор группы. |
groups[]. | integer Идентификатор группы. |
groups[]. | string Имя почтовой рассылки группы. Например, для адреса |
groups[]. | array Идентификаторы групп, в которые входит эта группа. |
groups[]. | array Участники группы. |
groups[]. | string Идентификатор участника группы. |
groups[]. | string Тип участника группы.
Значение по умолчанию:
|
groups[]. | integer Количество участников группы. |
groups[]. | string Название группы. |
groups[]. | boolean Признак удаленной группы: |
groups[]. | string Тип группы. |
page | integer Номер страницы ответа. |
pages | integer Количество страниц ответа. |
perPage | integer Количество групп на одной странице ответа. |
total | integer Общее количество групп. |
* Обязательный параметр
Код 401
Пользователь не авторизован.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 403
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 404
Запрашиваемый ресурс не найден.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр
Код 500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
{ "code": integer, "details": [ { "@type": string } ], "message": string }
Скопировано
Представление
Поля
code | integer |
details[] | array |
details[]. | string |
message | string |
code | integer |
details[] | array |
details[]. | string |
message | string |
* Обязательный параметр