Поля справочника

Введение

Возможности

API OKOCRM поддерживает чтение и запись контактов, компаний, сделок и других элементов системы. Это дает вам возможность, как просматривать, так и использовать дынные, которые храняться в OKOCRM в других своих сервисах.

Вы можете использовать API для импорта внешних данных в свою учетную запись OKOCRM.

Мы также работаем над интеграцией других сервисов в платформу OKOCRM. Эти сервисы будут доступны для всех пользователей OKOCRM для интеграции в платформу. Если вы планируете создать свою интеграцию, которая сможет использоваться на нашей платформе, свяжитесь с нами по адресу support@okocrm.com

Как это работает?

API OKOCRM основано на RESTfull API. URL-адрес okocrm.com API v1: https://api.okocrm.com/v1/.

Авторизация

Получить ключ авторизации

GET https://api.okocrm.com/v1/auth/
Параметр
Тип
Описание
Запрос
domain *
string
Поддомен Вашей системы
email *
string
E-mail при авторизации
password *
string
Пароль при авторизации
Ответ
site_id
string
Идентификаторы системы
access_token
string
Ключ авторизации
user_id
integer
Идентификатор пользователя
created_at
timestamp
Дата и время создания ключа в timestamp

Для работы с API Вам необходимо пройти авторизацию и получить идентификатор Вашей системы и ключ авторизации. Время жизни ключа авторизации - не ограничено.
Для последующих запросов к API нашей системы, Вам необходимо добавлять site_id и access_token ко всем запросам, в GET параметре.

Пользователи

Список пользователей

GET https://api.okocrm.com/v1/users/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор пользователя
name
string
ФИО
login
string
E-mail
role
integer
Идентификатор группы доступа
date_born
date
День рождения
phone
string
Телефон
date_job_start
date
Дата трудоустройства
date_job_end
date
Дата увольнения
department
integer
Идентификатор отдела
created_at
timestamp
Timestamp создания

Получить пользователя

GET https://api.okocrm.com/v1/users/{user_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор пользователя
name
string
ФИО
login
string
E-mail
role
integer
Идентификатор группы доступа
date_born
date
День рождения
phone
string
Телефон
date_job_start
date
Дата трудоустройства
date_job_end
date
Дата увольнения
department
integer
Идентификатор отдела
created_at
timestamp
Timestamp создания

Добавить пользователя

POST https://api.okocrm.com/v1/users/
Параметр
Тип
Описание
Запрос
name
string
ФИО
login
string
E-mail
password
string
Пароль, в не зашифрованном виде
role
integer
Идентификатор группы доступа
date_born
date
День рождения
phone
string
Телефон
date_job_start
date
Дата трудоустройства
date_job_end
date
Дата увольнения
department
integer
Идентификатор отдела
Ответ
id
integer
Идентификатор пользователя

Изменить пользователя

PUT https://api.okocrm.com/v1/users/{user_id}/
Параметр
Тип
Описание
Запрос
name
string
ФИО
login
string
E-mail
password
string
Пароль, в не зашифрованном виде
role
integer
Идентификатор группы доступа
date_born
date
День рождения
phone
string
Телефон
date_job_start
date
Дата трудоустройства
date_job_end
date
Дата увольнения
department
integer
Идентификатор отдела
Ответ
id
integer
Идентификатор пользователя

Удалить пользователя

DELETE https://api.okocrm.com/v1/users/{user_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор пользователя

Отделы

Список отделов

GET https://api.okocrm.com/v1/users/departments/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор отдела
pid
integer
Идентификатор родителя (при вложенности)
name
string
ФИО
description
text
Описание

Получить отдел

GET https://api.okocrm.com/v1/users/departments/{department_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор отдела

Контакты

Список контактов

GET https://api.okocrm.com/v1/contacts/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор контакта
name
string
ФИО
user_id
integer
Идентификатор ответственного
date_born
date
Дата рождения
source_id
integer
Источник
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
created_at
timestamp
Timestamp создания контакта
updated_at
timestamp
Timestamp последнего изменения контакта

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Получить контакт

GET https://api.okocrm.com/v1/contacts/{contact_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор контакта
name
string
ФИО
user_id
integer
Идентификатор ответственного
date_born
date
Дата рождения
source_id
integer
Источник
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
created_at
timestamp
Timestamp создания контакта
updated_at
timestamp
Timestamp последнего изменения контакта

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

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

POST https://api.okocrm.com/v1/contacts/
Параметр
Тип
Описание
Запрос
name *
string
ФИО
user_id
integer
Идентификатор ответственного
date_born
date
Дата рождения
source_id
integer
Источник
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
Ответ
id
string
Идентификатор контакта

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Изменить контакт

PUT https://api.okocrm.com/v1/contacts/{contact_id}/
Параметр
Тип
Описание
Запрос
name
string
ФИО
user_id
integer
Идентификатор ответственного
date_born
date
Дата рождения
source_id
integer
Источник
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
Ответ
id
integer
Идентификатор контакта

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Удалить контакт

DELETE https://api.okocrm.com/v1/contacts/{contact_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор контакта

Компании

Список компаний

GET https://api.okocrm.com/v1/companies/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор компании
name
string
Наименование компании
created_at
timestamp
Timestamp создания компании
updated_at
timestamp
Timestamp последнего изменения компании

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Получить компанию

GET https://api.okocrm.com/v1/companies/{company_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор компании
name
string
Наименование компании
full_name
string
Полное название компании
user_id
integer
Идентификатор ответственного
rek_inn
string
ИНН
director_name
string
ФИО руководителя
rek_rs
string
Расчетный счет
rek_kpp
string
КПП
rek_bank
string
Банк
rek_bik
string
БИК
rek_ks
string
Корр. счет
rek_ogrn
string
ОГРН
rek_okpo
string
ОКПО
address
string
Фактический адрес
rek_address
string
Юр.адрес
rek_mail_address
string
Почтовый адрес
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
created_at
timestamp
Timestamp создания компании
updated_at
timestamp
Timestamp последнего изменения компании

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Добавить компанию

POST https://api.okocrm.com/v1/companies/
Параметр
Тип
Описание
Запрос
name *
string
Название компании
full_name
string
Полное название компании
user_id
integer
Идентификатор ответственного
rek_inn
string
ИНН
director_name
string
ФИО руководителя
rek_rs
string
Расчетный счет
rek_kpp
string
КПП
rek_bank
string
Банк
rek_bik
string
БИК
rek_ks
string
Корр. счет
rek_ogrn
string
ОГРН
rek_okpo
string
ОКПО
address
string
Фактический адрес
rek_address
string
Юр.адрес
rek_mail_address
string
Почтовый адрес
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
Ответ
id
integer
Идентификатор компании

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Изменить компанию

PUT https://api.okocrm.com/v1/companies/{company_id}/
Параметр
Тип
Описание
Запрос
name
string
Название компании
full_name
string
Полное название компании
user_id
integer
Идентификатор ответственного
rek_inn
string
ИНН
director_name
string
ФИО руководителя
rek_rs
string
Расчетный счет
rek_kpp
string
КПП
rek_bank
string
Банк
rek_bik
string
БИК
rek_ks
string
Корр. счет
rek_ogrn
string
ОГРН
rek_okpo
string
ОКПО
address
string
Фактический адрес
rek_address
string
Юр.адрес
rek_mail_address
string
Почтовый адрес
phones
array
Массив телефонов
emails
array
Массив e-mail адресов
Ответ
id
integer
Идентификатор компании

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Удалить компанию

DELETE https://api.okocrm.com/v1/companies/{company_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор компании

Сделки

Список сделок

GET https://api.okocrm.com/v1/leads/
Параметр
Тип
Описание
Запрос
pipeline_id
integer
Идентификатор воронки
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор сделки
name
string
Название сделки
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
loss_reason_id
integer
Идентификатор причины закрытия сделки
closed
timestamp
Timestamp закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
budget
integer
Сумма сделки
tags
array
Массив тегов, которые привязаны к сделке
margin
integer
Маржа
guides
array
Массив элементов справочников и их количество, которые привязаны к сделке
guide_id
integer
Идентификатор справочника
item_id
integer
Идентификатор элемента справочника
count
integer
Количество
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source
integer
Источник
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
created_at
timestamp
Timestamp создания сделки
updated_at
timestamp
Timestamp последнего изменения сделки

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Получить сделку

GET https://api.okocrm.com/v1/leads/{lead_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор сделки
name
string
Название сделки
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
loss_reason_id
integer
Идентификатор причины закрытия сделки
closed
timestamp
Timestamp закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
budget
integer
Сумма сделки
tags
array
Массив тегов, которые привязаны к сделке
margin
integer
Маржа
guides
array
Массив элементов справочников и их количество, которые привязаны к сделке
guide_id
integer
Идентификатор справочника
item_id
integer
Идентификатор элемента справочника
count
integer
Количество
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source
integer
Источник
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
created_at
timestamp
Timestamp создания сделки
updated_at
timestamp
Timestamp последнего изменения сделки

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Создать сделку

POST https://api.okocrm.com/v1/leads/
Параметр
Тип
Описание
Запрос
pipeline_id *
integer
Идентификатор воронки
stages_id *
integer
Идентификатор этапа воронки
name *
string
Название сделки
loss_reason_id
integer
Идентификатор причины закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
tags
array
Массив тегов, которые привязаны к сделке
budget
integer
Сумма сделки
margin
integer
Маржа
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source
integer
Источник
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
guides
array
Массив элементов справочников и их количество, которые привязаны к сделке
guide_id *
integer
Идентификатор справочника
item_id *
integer
Идентификатор элемента справочника
count *
integer
Количество
Ответ
id
integer
Идентификатор сделки

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Изменить сделку

PUT https://api.okocrm.com/v1/leads/{lead_id}/
Параметр
Тип
Описание
Запрос
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
name
string
Название сделки
loss_reason_id
integer
Идентификатор причины закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
tags
array
Массив тегов, которые привязаны к сделке
budget
integer
Сумма сделки
margin
integer
Маржа
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source
integer
Источник
utm_source
string
UTM Source
utm_medium
string
UTM Medium
utm_campaign
string
UTM Campaign
utm_content
string
UTM Content
utm_term
string
UTM Term
guides
array
Массив элементов справочников и их количество, которые привязаны к сделке
guide_id *
integer
Идентификатор справочника
item_id *
integer
Идентификатор элемента справочника
count *
integer
Количество
Ответ
id
integer
Идентификатор сделки

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Удалить сделку

DELETE https://api.okocrm.com/v1/leads/{lead_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор сделки

Воронки

Список воронок

GET https://api.okocrm.com/v1/leads/pipelines/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор воронки
name
string
Название воронки

Получить воронку

GET https://api.okocrm.com/v1/leads/pipelines/{pipeline_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор воронки
name
string
Название воронки

Этапы воронок

Список этапов

GET https://api.okocrm.com/v1/leads/stages/
Параметр
Тип
Описание
Запрос
pipeline_id *
integer
Идентификатор воронки
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор этапа воронки
pipeline_id
integer
Идентификатор воронки
name
string
Название этапа воронки

Получить этап

GET https://api.okocrm.com/v1/leads/stages/{stage_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор этапа воронки
pipeline_id
integer
Идентификатор воронки
name
string
Название этапа воронки

Задачи

Список задач

GET https://api.okocrm.com/v1/task/
Параметр
Тип
Описание
Запрос
project_id
integer
Идентификатор проекта, в который вложены задачи
priority_id
integer
Идентификатор приоритета задачи
status_id
integer
Идентификатор статуса задачи
owner_id
integer
Идентификатор пользователя поставившего задачу
executer_id
integer
Идентификатор исполнителя задачи
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор задачи
task_pid
integer
Идентификатор родительской задачи (в случае вложенности)
project_id
integer
Идентификатор проекта
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
title
string
Тема задачи
text
text
Текст задачи
created_at
timestamp
Timestamp создания задачи
startDate
timestamp
Timestamp планируемого начала выполнения задачи
endDate
timestamp
Timestamp планируемого окончания выполнения задачи
closeDate
timestamp
Timestamp фактического закрытия задачи
status_id
integer
Идентификатор статуса задачи
priority_id
integer
Идентификатор приоритета задачи
owner_id
integer
Идентификатор пользователя поставившего задачу
executer_id
integer
Идентификатор исполнителя задачи
realTime
integer
Затраченное время на выполнение задачи, в минутах

Получить задачу

GET https://api.okocrm.com/v1/task/{task_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор задачи
task_pid
integer
Идентификатор родительской задачи (в случае вложенности)
project_id
integer
Идентификатор проекта
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
title
string
Тема задачи
text
text
Текст задачи
created_at
timestamp
Timestamp создания задачи
startDate
timestamp
Timestamp планируемого начала выполнения задачи
endDate
timestamp
Timestamp планируемого окончания выполнения задачи
closeDate
timestamp
Timestamp фактического закрытия задачи
status_id
integer
Идентификатор статуса задачи
priority_id
integer
Идентификатор приоритета задачи
owner_id
integer
Идентификатор пользователя поставившего задачу
executer_id
integer
Идентификатор исполнителя задачи
realTime
integer
Затраченное время на выполнение задачи, в минутах

Создать задачу

POST https://api.okocrm.com/v1/task/
Параметр
Тип
Описание
Запрос
task_pid
integer
Идентификатор родительской задачи (в случае вложенности)
project_id
integer
Идентификатор проекта
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
title *
string
Тема задачи
text
text
Текст задачи
startDate
timestamp
Timestamp планируемого начала выполнения задачи
endDate
timestamp
Timestamp планируемого окончания выполнения задачи
priority_id
integer
Идентификатор приоритета задачи
executer_id *
integer
Идентификатор исполнителя задачи
Ответ
id
integer
Идентификатор задачи

Изменить задачу

PUT https://api.okocrm.com/v1/task/{task_id}/
Параметр
Тип
Описание
Запрос
task_pid
integer
Идентификатор родительской задачи (в случае вложенности)
project_id
integer
Идентификатор проекта
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
title
string
Тема задачи
text
text
Текст задачи
startDate
timestamp
Timestamp планируемого начала выполнения задачи
endDate
timestamp
Timestamp планируемого окончания выполнения задачи
priority_id
integer
Идентификатор приоритета задачи
executer_id *
integer
Идентификатор исполнителя задачи
Ответ
id
integer
Идентификатор задачи

Удалить задачу

DELETE https://api.okocrm.com/v1/task/{task_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор задачи

Типы задачи

Список типов

GET https://api.okocrm.com/v1/task/types/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор
title
string
Название типа
icon
string
Иконка
color
string
Цвет иконки

Получить тип задачи

GET https://api.okocrm.com/v1/task/types/{type_id}/
Параметр
Тип
Описание
Запрос
id
string
Идентификатор
Ответ
id
integer
Идентификатор
title
string
Название типа
icon
string
Иконка
color
string
Цвет иконки

Комментарии в задаче

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

GET https://api.okocrm.com/v1/task/comments/
Параметр
Тип
Описание
Запрос
task_id *
integer
Идентификатор задачи, комментарии которой необходимы
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор
task_id
integer
Идентификатор задачи, к которой написан комментарий
user_id
integer
Идентификатор автора комментария
text
text
Текст комментария
created_at
timestamp
Timestamp создания комментария

Получить комментарий

GET https://api.okocrm.com/v1/task/comments/{comment_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор
task_id
integer
Идентификатор задачи, к которой написан комментарий
user_id
integer
Идентификатор автора комментария
text
text
Текст комментария
created_at
timestamp
Timestamp создания комментария

Добавить комментарий

POST https://api.okocrm.com/v1/comments/
Параметр
Тип
Описание
Запрос
task_id *
integer
Идентификатор задачи, к которой комментарий
text *
text
Текст комментария
Ответ
id
integer
Идентификатор комментария

Примечания

Список примечаний

GET https://api.okocrm.com/v1/notes/
Параметр
Тип
Описание
Запрос
lead_id
integer
Идентификатор сделки, к которой привязано примечание
contact_id
integer
Идентификатор контакта, к которой привязано примечание
company_id
integer
Идентификатор компании, к которой привязано примечание
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
user_id
integer
Идентификатор автора примечания
created_at
timestamp
Timestamp создания примечания
text
text
Текст примечания

Получить примечание

GET https://api.okocrm.com/v1/notes/{note_id}/
Параметр
Тип
Описание
Ответ
user_id
integer
Идентификатор автора примечания
created_at
timestamp
Timestamp создания примечания
text
text
Текст примечания

Добавить примечание

POST https://api.okocrm.com/v1/notes/
Параметр
Тип
Описание
Запрос
lead_id
integer
Идентификатор сделки, к которой привязано примечание
contact_id
integer
Идентификатор контакта, к которой привязано примечание
company_id
integer
Идентификатор компании, к которой привязано примечание
text
text
Текст примечания
Ответ
id
integer
Идентификатор примечания

Справочники

Список справочников

GET https://api.okocrm.com/v1/guides/
Параметр
Тип
Описание
Запрос
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор справочника
name
string
Название справочника

Получить справочник

GET https://api.okocrm.com/v1/guides/{guide_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор справочника
name
string
Название справочника

Создать справочник

POST https://api.okocrm.com/v1/guides/
Параметр
Тип
Описание
Запрос
name *
string
Название справочника
Ответ
id
integer
Идентификатор справочника

Изменить справочник

PUT https://api.okocrm.com/v1/guides/{guide_id}/
Параметр
Тип
Описание
Запрос
name
string
Название справочника
Ответ
id
integer
Идентификатор справочника

Удалить справочник

DELETE https://api.okocrm.com/v1/guides/{guide_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор справочника

Элементы справочника

Получить список

GET https://api.okocrm.com/v1/guides/items/
Параметр
Тип
Описание
Запрос
guide_id *
integer
Идентификатор справочника, список элементов которого необходим
offset
integer
Сдвиг выборки (с какой строки выбирать). Работает, только при условии, что limit тоже указан
limit
integer
Кол-во выбираемых строк (системное ограничение 100)
Ответ
id
integer
Идентификатор элемента
guide_id
integer
Идентификатор справочника
name
string
Наименование элемента справочника

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Получить элемент

GET https://api.okocrm.com/v1/guides/items/{item_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор элемента
guide_id
integer
Идентификатор справочника
name
string
Наименование элемента справочника

В списке возвращаемых полей, динамически выводятся дополнительные поля, которые являются уникальными у каждого клиента, в зависимости от настроек

Добавить элемент

POST https://api.okocrm.com/v1/guides/items/
Параметр
Тип
Описание
Запрос
guide_id *
integer
Идентификатор справочника
name *
string
Наименование элемента списка
price
integer
Цена
Ответ
id
integer
Идентификатор элемента списка

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Изменить элемент

PUT https://api.okocrm.com/v1/guides/items/{item_id}/
Параметр
Тип
Описание
Запрос
guide_id
integer
Идентификатор справочника
name
string
наименование элемента справочника
price
integer
Цена
Ответ
id
integer
Идентификатор элемента списка

В передаваемый список полей добавляются уникальные, для каждого клиента, поля которые настраиваются в системе

Удалить элемент

DELETE https://api.okocrm.com/v1/guides/items/{item_id}/
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор элемента справочника

Поля справочника

Список полей

GET https://api.okocrm.com/v1/guides/fields/
Параметр
Тип
Описание
Запрос
guide_id *
integer
Идентификатор справочника
Ответ
var_name
string
Ключ поля в массиве
type
string
Тип поля
name
string
Наименование поля
enums
array
Список элементов у поля