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

  1. HTTP-запрос
  2. Query-параметры
  3. Ответы
    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\
?pageSize={integer}\
&pageToken={string}

Query-параметры

pageSize

integer

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

pageToken

string

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

pageSize

integer

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

pageToken

string

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

Ответы

Код 200

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

{
  "nextPageToken": string,
  "organizations": [
    {
      "email": string,
      "fax": string,
      "id": integer,
      "language": string,
      "name": string,
      "phone": string,
      "subscriptionPlan": string
    }
  ]
}
Скопировано

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

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

Поля

nextPageToken

string

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

organizations[]

array

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

organizations[].email

string

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

organizations[].fax

string

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

organizations[].id

integer

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

organizations[].language

string

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

organizations[].name

string

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

organizations[].phone

string

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

organizations[].subscriptionPlan

string

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

nextPageToken

string

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

organizations[]

array

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

organizations[].email

string

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

organizations[].fax

string

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

organizations[].id

integer

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

organizations[].language

string

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

organizations[].name

string

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

organizations[].phone

string

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

organizations[].subscriptionPlan

string

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

Код 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