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

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

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

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

Headers

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

Path

idRequired integer ID-пользователя

Создать пользователя post

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

Headers

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

Body

nameRequired string
emailRequired string
timezoneRequired string Таймзоны
date_formatRequired string

Допустимые значения:

['d-m-Y', 'd/m/Y', 'm-d-Y', 'm.d.Y', 'm/d/Y', 'Y-m-d', 'd.m.Y', 'F j, Y', 'j F, Y', 'D, F j, Y', 'l, F j, Y']
time_formatRequired string

Допустимые значения:

G:i A - AM/PM
G:i a - am/pm
H:i:s - 24 часовой
first_day_of_weekRequired integer

Допустимые значения:

1 - Понедельник
6 - Суббота
0 - Воскресенье
localeOptional string Примечание Поддерживается только RU.
rolesOptional array Роли пользователей
super_adminOptional boolean Важно Указывает, является ли пользователь администратором.
access_apiOptional boolean Указывает, может ли пользователь создавать ключи и использовать API. Обратите внимание: если для параметра super_admin установлено значение true, доступ к API всегда будет разрешен.
mail_signatureOptional string
passwordRequired string
password_confirmationRequired string

Редактировать пользователя put

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

Headers

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

Path

idRequired integer ID-пользователя

Body

nameRequired string
emailRequired string
timezoneRequired string Таймзоны
date_formatRequired string

Допустимые значения:

['d-m-Y', 'd/m/Y', 'm-d-Y', 'm.d.Y', 'm/d/Y', 'Y-m-d', 'd.m.Y', 'F j, Y', 'j F, Y', 'D, F j, Y', 'l, F j, Y']
time_formatRequired string

Допустимые значения:

G:i A - AM/PM
G:i a - am/pm
H:i:s - 24 часовой
first_day_of_weekRequired integer

Допустимые значения:

1 - Понедельник
6 - Суббота
0 - Воскресенье
localeRequired string Примечание Поддерживается только RU.
rolesOptional array Роли пользователей
super_adminOptional boolean Важно Указывает, является ли пользователь администратором.
access_apiOptional boolean Указывает, может ли пользователь создавать ключи и использовать API. Обратите внимание: если для параметра super_admin установлено значение true, доступ к API всегда будет разрешен.
mail_signatureOptional string
passwordOptional string Примечание Если указан, пароль пользователя будет обновлен.

Удалить пользователя delete

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

Headers

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

Path

idRequired integer ID-пользователя

Поиск пользователя get

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

Войти в CRM пользователем get

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

Headers

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

Редактировать профиль put

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

Headers

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

Body

nameRequired string
emailRequired string
timezoneRequired string Таймзоны
date_formatRequired string

Допустимые значения:

['d-m-Y', 'd/m/Y', 'm-d-Y', 'm.d.Y', 'm/d/Y', 'Y-m-d', 'd.m.Y', 'F j, Y', 'j F, Y', 'D, F j, Y', 'l, F j, Y']
time_formatRequired string

Допустимые значения:

G:i A - AM/PM
G:i a - am/pm
H:i:s - 24 часовой
first_day_of_weekRequired integer

Допустимые значения:

1 - Понедельник
6 - Суббота
0 - Воскресенье
localeRequired string Примечание Поддерживается только RU.
rolesOptional array Роли пользователей
mail_signatureOptional string

Смена пароля put

https://userID.aircrm.io/api/profile/password

Headers

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

Body

old_passwordRequired string Текущий пароль
passwordRequired string Новый пароль
password_confirmationRequired string Подтвердить новый пароль