Источники

Список источников get

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

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

Headers

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

Path

idRequired integer ID-записи

Создать источник post

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

Headers

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

Body

nameRequired string

Редактировать источник put

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

Headers

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

Path

idRequired integer ID-записи

Body

nameRequired string

Удалить источник delete

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

Headers

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

Path

idRequired integer ID-записи

Поиск источника get

https://userID.aircrm.io/api/sources/search?q={query}
Используйте для поиска без разбивки на страницы (параметр take).

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