Информация о домене аккаунта

В данном разделе описывается работа с методом получения информации о домене аккаунта

Получение информации о домене аккаунта по Access Token

Метод

GET /oauth2/account/subdomain

Описание

Метод позволяет получить информации о домене аккаунта.
Метод может быть полезен в случае смены субдомена аккаунта, с которым вы работаете. При наличии активного Access Token, вы можете сделать запрос к этому методу и получить информацию о домене аккаунта.

Ограничения

  • Метод доступен только с активным Access Token’ом интеграции
  • Метод доступен только на промосайтах https://www.amocrm.ru и https://www.amocrm.com

Пример запроса

Запрос должен уходить на host: www.amocrm.ru или www.amocrm.com, в зависимости от аккаунта

        
curl 'https://www.amocrm.ru/oauth2/account/subdomain' -H 'Authorization: Bearer {access_token}'
        
    

Заголовок типа данных при успешном результате

Content-Type: application/json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
200 Запрос выполнен успешно
401 Пользователь не авторизован

Параметры ответа

Метод возвращает информацию о домене аккаунта, рассмотрим ниже свойства.

Параметр Тип данных Описание
id int ID аккаунта
subdomain string Судбомен аккаунта
domain string Полный домен аккаунта
top_level_domain string Домен верхнего уровня аккаунта (ru или com)

Пример ответа

        
{
    "id": 123456,
    "subdomain": "account_subdomain",
    "domain": "account_subdomain.amocrm.ru",
    "top_level_domain": "ru"
}