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

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

Примечание

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

Request

GET

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

Query parameters

Name

Description

pageSize

Type: integer

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

pageToken

Type: string

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

Example: ``

Responses

200 OK

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

Body

application/json

{
  "organizations": [
    {
      "id": 0,
      "name": "example",
      "email": "example",
      "phone": "example",
      "fax": "example",
      "language": "example",
      "subscriptionPlan": "example"
    }
  ],
  "nextPageToken": "example"
}

Name

Description

nextPageToken

Type: string

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

Example: example

organizations

Type: v1Organization[]

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

Example

[
  {
    "id": 0,
    "name": "example",
    "email": "example",
    "phone": "example",
    "fax": "example",
    "language": "example",
    "subscriptionPlan": "example"
  }
]

v1Organization

Name	Description
email	Type: string Адрес почтовой рассылки организации. Example: `example`
fax	Type: string Номер факса организации. Example: `example`
id	Type: integer Идентификатор организации.
language	Type: string Язык организации. Example: `example`
name	Type: string Название организации. Example: `example`
phone	Type: string Номер телефона организации. Example: `example`
subscriptionPlan	Type: string Тарифный план организации. Example: `example`

Example

{
  "id": 0,
  "name": "example",
  "email": "example",
  "phone": "example",
  "fax": "example",
  "language": "example",
  "subscriptionPlan": "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`

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

Обзор