Компании

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

https://userID.aircrm.pro/api/companies

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.pro/api/companies/{id}

Headers

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

Path

idRequired integer ID-записи

Создать компанию post

https://userID.aircrm.pro/api/companies

Headers

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

Body

nameRequired string
emailOptional string
domainOptional string
phonesOptional array Пример:
[
    [ "number" => "+79381120885", "type" => "mobile" ],
    [ "number" => "+79381145885", "type" => "work" ],
    [ "number" => "+319381120885", "type" => "other"'],
]
user_idOptional integer Ответственный за компанию
source_idOptional integer ID источника
industry_idOptional integer ID отрасли
parent_company_idOptional integer
streetOptional string
cityOptional string
stateOptional string
postal_codeOptional string
country_idOptional integer ID страны
contactsOptional array Массив ID контактов, с которыми связана компания.
dealsOptional array Массив ID сделок, с которыми связана компания.
...customFieldsOptional mixed Любое дополнительное поле

Редактировать компанию put

https://userID.aircrm.pro/api/companies/{id}

Headers

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

Path

idRequired integer ID-записи

Body

nameRequired string
emailOptional string
domainOptional string
phonesOptional array Пример:
[
    [ "number" => "+79381120885", "type" => "mobile" ],
    [ "number" => "+79381145885", "type" => "work" ],
    [ "number" => "+319381120885", "type" => "other"'],
]
user_idOptional integer Ответственный за компанию
source_idOptional integer ID источника
industry_idOptional integer ID отрасли
parent_company_idOptional integer
streetOptional string
cityOptional string
stateOptional string
postal_codeOptional string
country_idOptional integer ID страны
contactsOptional array Массив ID контактов, с которыми связана компания.
dealsOptional array Массив ID сделок, с которыми связана компания.
...customFieldsOptional mixed Любое дополнительное поле

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

https://userID.aircrm.pro/api/companies/{id}

Headers

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

Path

idRequired integer ID-записи

Поиск get

https://userID.aircrm.pro/api/companies/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.pro/api/associations/companies/{id}

Headers

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

Path

idRequired integer ID-записи

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

Body

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

Отвязать записи от компании delete

https://userID.aircrm.pro/api/associations/companies/{id}

Headers

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

Path

idRequired integer ID-записи

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

Body

contactsOptional array Массив ID контактов для отсоединения
dealsOptional array Массив ID сделок для отсоединения
activitiesOptional array Массив ID задач для отсоединения

Синхронизация связей с компанией post

https://userID.aircrm.pro/api/associations/companies/{id}

Headers

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

Path

idRequired integer ID-записи

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

Body

contactsOptional array Массив ID контактов для синхронизации
dealsOptional array Массив ID сделок для синхронизации
activitiesOptional array Массив ID задач для синхронизации