Получение списка организаций контактов
Получение списка организаций контактов
| Метод | get.contact_organizations |
|---|---|
| Описание | Получение списка организаций контактов |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
filter |
object | нет | См. раздел "Критерии фильтрации" |
fields |
array | нет | См. раздел "Представление возвращаемых данных" |
sort |
array | нет | См. раздел "Сортировка данных" |
Параметры ответа
| Название | Тип | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|
id |
number | да | Уникальный идентификатор организации | |
name |
string | да | да | Название организации |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.contact_organizations",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"name":"string"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"