Посмотреть список организаций

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

Примечание

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

Request

GET

https://api360.yandex.net/directory/v1/org

Query parameters

Name

Description

pageSize

Type: integer<int64>

Количество организаций на странице. Максимальное значение — 100. По умолчанию — 10.

pageToken

Type: string

Токен постраничной навигации.

Responses

200 OK

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

Body

application/json
{
    "organizations": [
        {
            "id": 0,
            "name": "string",
            "email": "string",
            "phone": "string",
            "fax": "string",
            "language": "string",
            "subscriptionPlan": "string"
        }
    ],
    "nextPageToken": "string"
}

Name

Description

nextPageToken

Type: string

Токен для получения следующей страницы постраничной навигации.

organizations

Type: v1Organization[]

Список организаций.

v1Organization

Name

Description

email

Type: string

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

fax

Type: string

Номер факса организации.

id

Type: integer<int64>

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

language

Type: string

Язык организации.

name

Type: string

Название организации.

phone

Type: string

Номер телефона организации.

subscriptionPlan

Type: string

Тарифный план организации.

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

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