Просмотреть контакт

Возвращает информацию об одном внешнем контакте.

Request

GET

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

Path parameters

Name

Description

contactId*

Type: string

Идентификатор внешнего контакта.

orgId*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json
{
    "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"
}

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-телефон;
  • для порочих телефоных номеров оставьте поле незаполненным.

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

Описание ошибки.
Предыдущая
Добавить контакт
Следующая
Удалить контакт