Задачи

Список задач get

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

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/activities/{id}

Headers

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

Path

idRequired integer ID-записи

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

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

Headers

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

Body

titleRequired string
activity_type_idOptional integer ID типа задач

Если не указан, будет использоваться по умолчанию (в Настройки->Задачи).
user_idRequired integer Ответственный за задачу
noteOptional string
descriptionOptional string
due_dateRequired date В UTC-формате

Пример:
Только дата: 2022-06-07
Со временем: 2022-06-07 10:00:00
end_dateOptional date В UTC-формате

Пример:
Только дата: 2022-06-07
Со временем: 2022-06-07 10:00:00

Если это не указано, дата выполнения задачи = даты окончания.
reminder_minutes_beforeOptional integer В минутах, чтобы отправить напоминание
guestsOptional array Пример: 
[
  "users"    => [2, 3],
  "contacts" => [4, 5],
]
contactsOptional array Массив ID контактов, с которыми связана задача.
companiesOptional array Массив ID компаний, с которыми связана задача.
dealsOptional array Массив ID сделок, с которыми связана задача.

Редактировать задачу put

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

Headers

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

Path

idRequired integer ID-записи

Body

titleRequired string
activity_type_idOptional integer ID типа задач

Если не указан, будет использоваться по умолчанию (в Настройки->Задачи).
user_idOptional integer Ответственный за задачу
noteOptional string
descriptionOptional string
due_dateOptional date В UTC-формате

Пример:
Только дата: 2022-06-07
Со временем: 2022-06-07 10:00:00
end_dateOptional date В UTC-формате

Пример:
Только дата: 2022-06-07
Со временем: 2022-06-07 10:00:00

Если это не указано, дата выполнения задачи = даты окончания.
reminder_minutes_beforeOptional integer В минутах, чтобы отправить напоминание
guestsOptional array Пример: 
[
  "users"    => [2, 3],
  "contacts" => [4, 5],
]
contactsOptional array Массив ID контактов, с которыми связано действие.
companiesOptional array Массив ID компаний, с которыми связано действие.
dealsOptional array Массив ID сделок, с которыми связано действие.

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

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

Headers

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

Path

idRequired integer ID-записи

Поиск get

https://userID.aircrm.io/api/activities/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

Связать задачу с записями put

https://userID.aircrm.io/api/associations/activities/{id}

Headers

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

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов для прикрепления
companiesOptional array Массив ID компаний для прикрепления
dealsOptional array Массив ID задач для прикрепления

Отвязать задачу от записей delete

https://userID.aircrm.io/api/associations/activities/{id}

Headers

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

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов для отвязки
companiesOptional array Массив ID компаний для отвязки
dealsOptional array Массив ID задач для отвязки

Синхронизация связей с задачей post

https://userID.aircrm.io/api/associations/activities/{id}

Headers

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

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов
companiesOptional array Массив ID компаний
dealsOptional array Массив ID задач

Сменить статус задачи post

https://userID.aircrm.io/api/activities/{id}/{status}

Headers

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

Path

idRequired integer ID-записи
statusRequired string Любой из ['complete', 'incomplete']