Введение

Возможности

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

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

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

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

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

Авторизация

Заголовок запроса

Ко всем запросам к API необходимо добавить 2 header:

Accept: application/json
Authorization: Bearer токен

Токен можно получить в разделе личного профиля, в okocrm, в графе "Токен для API".
Обратите внимание, что все запросы к api будут иметь те же права, что имеет пользователь этого токена.

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

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

GET https://api.okocrm.com/v2/users/
Метод позволяет получить весь список пользователей
Параметр
Тип
Описание
Запрос
page
integer
Страница с результатами
Ответ
id
integer
Идентификатор пользователя
name
string
ФИО
login
string
E-mail
role_id
integer
Идентификатор группы доступа
date_born
date
День рождения
phone
string
Телефон
date_job_start
date
Дата трудоустройства
date_job_end
date
Дата увольнения
department_id
integer
Идентификатор отдела
created_at
timestamp
Timestamp создания
updated_at
timestamp
Timestamp редактирования

Контакты

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

GET https://api.okocrm.com/v2/contacts/
Получить весь список контактов
Параметр
Тип
Описание
Запрос
page
integer
Номер страницы
Ответ
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/v2/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/v2/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/v2/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/v2/contacts/{contact_id}/
Удаление контакта, по его идентификатору. Фактически, контакт не удаляется, а деактивируется.

Компании

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

GET https://api.okocrm.com/v2/companies/
Получить весь список компаний
Параметр
Тип
Описание
Запрос
page
integer
Номер страницы
Ответ
id
integer
Идентификатор
name
string
Наименование
user_id
integer
Идентификатор ответственного
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/v2/companies/{company_id}/
Получить информацию о компании, по её идентификатору
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор
name
string
ФИО
user_id
integer
Идентификатор ответственного
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/v2/companies/
Добавить новую компанию
Параметр
Тип
Описание
Запрос
name *
string
ФИО
user_id
integer
Идентификатор ответственного
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/v2/companies/{company_id}/
Изменить, любую, информацию о компании, по её идентификатору
Параметр
Тип
Описание
Запрос
name
string
ФИО
user_id
integer
Идентификатор ответственного
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/v2/companies/{company_id}/
Удаление компании, по её идентификатору. Фактически, компания не удаляется, а деактивируется.

Сделки

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

GET https://api.okocrm.com/v2/leads/
Получить весь список сделок, по всем воронкам и этапам воронок
Параметр
Тип
Описание
Запрос
page
integer
Номер страницы
Ответ
id
integer
Идентификатор сделки
name
string
Название сделки
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
loss_reason_id
integer
Идентификатор причины закрытия сделки
closed_at
timestamp
Timestamp закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
budget
integer
Сумма сделки
tags
array
Массив тегов, которые привязаны к сделке
margin
integer
Маржа
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source_id
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/v2/leads/{lead_id}/
Получить всю информаци о сделке, по её идентификатору
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор сделки
name
string
Название сделки
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
loss_reason_id
integer
Идентификатор причины закрытия сделки
closed_at
timestamp
Timestamp закрытия сделки
contacts
array
Массив идентификаторов контактов, которые привязаны к сделке
companies
array
Массив идентификаторов компаний, которые привязаны к сделке
budget
integer
Сумма сделки
tags
array
Массив тегов, которые привязаны к сделке
margin
integer
Маржа
user_id
integer
Идентификатор ответственного
client_type
integer
Тип клиента
city_id
integer
Идентификатор города
source_id
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/v2/leads/
Добавление новой сделки
Параметр
Тип
Описание
Запрос
pipeline_id *
integer
Идентификатор воронки
stages_id *
integer
Идентификатор этапа воронки
name *
string
Название сделки
loss_reason_id
integer
Идентификатор причины закрытия сделки
tags
array
Массив тегов, которые привязаны к сделке
budget
integer
Сумма сделки
margin
integer
Маржа
user_id
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
contact
array
Привязываемый контакт
name
string
ФИО контакта
phone
string
Телефон контакта
Ответ
lead_id
integer
Идентификатор сделки
contact_id
integer
Идентификатор контакта

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

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

PUT https://api.okocrm.com/v2/leads/{lead_id}/
Обновление информации о сделке
Параметр
Тип
Описание
Запрос
pipeline_id
integer
Идентификатор воронки
stages_id
integer
Идентификатор этапа воронки
name
string
Название сделки
loss_reason_id
integer
Идентификатор причины закрытия сделки
tags
array
Массив тегов, которые привязаны к сделке
budget
integer
Сумма сделки
margin
integer
Маржа
user_id
integer
Идентификатор ответственного
city_id
integer
Идентификатор города
source_id
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

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

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

DELETE https://api.okocrm.com/v2/leads/{lead_id}/
Удаление сделки, по её идентификатору. Фактически, сделка не удаляется, а деактивируется.

Воронки

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

GET https://api.okocrm.com/v2/leads/pipelines/
Получить список воронок
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор воронки
name
string
Название воронки

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

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

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

Задачи

Список задач

GET https://api.okocrm.com/v2/tasks/
Получить список задач
Параметр
Тип
Описание
Запрос
lead_id
integer
Идентификатор задачи
contact_id
integer
Идентификатор контакта
company_id
integer
Идентификатор компании
Ответ
id
integer
Идентификатор задачи
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
text
text
Текст задачи
created_at
timestamp
Timestamp создания задачи
date_start
timestamp
Timestamp планируемого начала выполнения задачи
date_finish
timestamp
Timestamp планируемого окончания выполнения задачи
closed_at
timestamp
Timestamp фактического закрытия задачи
done
integer
Признак закрытой задачи
owner_id
integer
Идентификатор пользователя поставившего задачу
executer_id
integer
Идентификатор исполнителя задачи
process_time
integer
Затраченное время на выполнение задачи, в минутах

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

POST https://api.okocrm.com/v2/tasks/
Создать задачу
Параметр
Тип
Описание
Запрос
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
text
text
Текст задачи
date_start
date
Срок задачи в формате Y-m-d H:i
date_finish
date
Срок задачи в формате Y-m-d H:i
executer_id *
integer
Идентификатор исполнителя задачи
Ответ
id
integer
Идентификатор задачи

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

PUT https://api.okocrm.com/v2/tasks/{task_id}/
Изменить задачу, по её идентификатору
Параметр
Тип
Описание
Запрос
type_id
integer
Идентификатор типа задачи
contact_id
integer
Идентификатор контакта, к которому привязана задача
lead_id
integer
Идентификатор сделки, к которой привязана задача
company_id
integer
Идентификатор компании, к которой привязана задача
text
text
Текст задачи
date_start
date
Срок задачи в формате Y-m-d H:i
date_finish
date
Срок задачи в формате Y-m-d H:i
executer_id *
integer
Идентификатор исполнителя задачи
Ответ
id
integer
Идентификатор задачи

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

DELETE https://api.okocrm.com/v2/tasks/{task_id}/
Удалить задачу, по её идентификатору

Задача выполнена + комментарий

POST https://api.okocrm.com/v2/tasks/done/{id}
Отметка выполнения задачи и добавление комментария по ней
Параметр
Тип
Описание
Запрос
text
string
Комментарий

Типы задачи

Список типов

GET https://api.okocrm.com/v2/task/types/
Получить список типов
Параметр
Тип
Описание
Ответ
id
integer
Идентификатор
title
string
Название типа
icon
string
Иконка
color
string
Цвет иконки
Наверх
Мы используем cookie для вашего удобства. Используя сайт, вы соглашаетесь с этим. Подробнее - в политике конфиденциальности.
Я согласен