Просмотреть список контактов

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

Request

GET

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Query parameters

Name

Description

page

Type: integer<int64>

Номер страницы ответа. Значение по умолчанию — 1.

perPage

Type: integer<int64>

Количество контактов на одной странице ответа. Значение по умолчанию — 10.

Responses

200 OK

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

Body

application/json

{
    "contacts": [
        {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "middleName": "string",
            "title": "string",
            "company": "string",
            "department": "string",
            "address": "string",
            "externalId": "string",
            "emails": [
                {
                    "email": "string",
                    "type": "string",
                    "main": false
                }
            ],
            "phones": [
                {
                    "phone": "string",
                    "type": "string",
                    "main": false
                }
            ],
            "createdAt": "2022-12-29T18:02:01Z",
            "updatedAt": "2022-12-29T18:02:01Z"
        }
    ],
    "page": 0,
    "pages": 0,
    "perPage": 0,
    "total": 0
}

Name	Description
contacts	Type: v1ExternalContact[] Список внешних контактов.
page	Type: integer<int64> Номер страницы ответа.
pages	Type: integer<int64> Количество страниц ответа.
perPage	Type: integer<int64> Количество результатов на одной странице ответа.
total	Type: integer<int64> Общее количество результатов.

v1ExternalContact

Name	Description
emails*	Type: v1ExternalContactEmail[] Электронные адреса.
firstName*	Type: string Имя.
id*	Type: string Идентификатор внешнего контакта.
lastName*	Type: string Фамилия.
address	Type: string Почтовый адрес.
company	Type: string Компания.
createdAt	Type: string<date-time> Дата и время создания.
department	Type: string Подразделение.
externalId	Type: string Произвольный внешний идентификатор.
middleName	Type: string Отчество.
phones	Type: v1ExternalContactPhone[] Телефоны.
title	Type: string Должность.
updatedAt	Type: string<date-time> Дата и время изменения.

v1ExternalContactEmail

Name	Description
email	Type: string Электронный адрес.
main	Type: boolean Признак основного электронного адреса: `true` — основной (обязательно должен быть ровно у одного адреса); `false` — дополнительный.
type	Type: string Тип электронного адреса. Возможные значения: `work` — для рабочей почты; для личной почты пользователя оставьте поле незаполненным.

v1ExternalContactPhone

Name	Description
main	Type: boolean Признак основного телефона: `true` — основной (может быть не более чем у одного телефона); `false` — дополнительный.
phone	Type: string Телефон.
type	Type: string Тип телефона. Возможные значения: `work` — рабочий телефон; `mobile` — мобильный телефон; `ip` — IP-телефон; для прочих телефонных номеров оставьте поле незаполненным.

400 Bad Request

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

protobufAny

Name	Description
@type	Type: string
[additional]	Type: any

401 Unauthorized

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

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

Обзор

Добавить контакт