Воронки

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

https://userID.aircrm.io/api/pipelines

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Query

orderOptional string Отсортируйте запрашиваемые результаты.
Пример: ?order=created_at или ?order=created_at|desc
selectOptional string Выберите только нужные поля (для оптимизации запросов).
Пример: ?select=first_name;id
per_pageOptional integer Укажите количество записей.
Пример: ?per_page=20
pageOptional integer Номер страницы.
Пример: ?page=2
qOptional string Поиск по заданному запросу.
Пример: ?q=Dmitry
search_fieldsOptional string Измените поля, по которым будет выполняться поиск.
Пример:?search_fields=email:like;phones.number:=
search_matchOptional string По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND.
Пример: ?search_match=and

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

https://userID.aircrm.io/api/pipelines/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Создать воронку post

https://userID.aircrm.io/api/pipelines

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Body

nameRequired string
stagesOptional array Массив с этапами
Пример: 
[
    ["name" => "Начало", "win_probability" => 20, "display_order" => 1],
    ["name" => "Ещё один этап", "win_probability" => 40, "display_order" => 2],
]

Изменить воронку put

https://userID.aircrm.io/api/pipelines/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Body

nameRequired string
stagesOptional array Массив с этапами
Пример: 
[
    ["name" => "Начало", "win_probability" => 20, "display_order" => 1],
    ["name" => "Ещё один этап", "win_probability" => 40, "display_order" => 2],
]

Удалить воронку delete

https://userID.aircrm.io/api/pipelines/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Поиск get

https://userID.aircrm.io/api/pipelines/search?q={query}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

qRequired string

Query

takeOptional integer Максимальное количество результатов.
Пример: ?take=1
orderOptional string Отсортируйте запрашиваемые результаты.
Пример: ?order=created_at или ?order=created_at|desc
selectOptional string Выберите только нужные поля (для оптимизации запросов).
Пример: ?select=first_name;id
search_fieldsOptional string Измените поля, по которым будет выполняться поиск.
Пример:?search_fields=email:like;phones.number:=
search_matchOptional string По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND.
Пример: ?search_match=and

Получить этапы воронки get

https://userID.aircrm.io/api/pipelines/{id}/stages

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи