🖇️Users

API Endpoints for Users

List Users GET

Endpoint: https://subdomain.appcrm.com.br/api/users

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Query Parameters

order	Optional	string	Sort the results being queried. Example: ?order=created_at or ?order=created_at|desc
select	Optional	string	Select only the provided fields, useful for query optimization. Example: ?select=first_name;id
per_page	Optional	integer	Provide the total number of records to query per page. Example: ?per_page=20
page	Optional	integer	The page number to retrieve results for. Example: ?page=2
q	Optional	string	Search records by a given query. Example: ?q=John
search_fields	Optional	string	Change the fields that the search will be performed to Example:?search_fields=email:like;phones.number:=
search_match	Optional	string	By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator. Example: ?search_match=and

Retrieve User GET

Endpoint: https://subdomain.appcrm.com.br/api/users/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Create User POST

Endpoint: https://subdomain.appcrm.com.br/api/users

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Body Parameters

name	Required	string
email	Required	string
timezone	Required	string	Timezone name from the supported timezones
date_format	Required	string	Accepted values: ['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_format	Required	string	Accepted values: G:i A - AM/PM G:i a - am/pm H:i:s - 24 hours
locale	Optional	string	Note The provided locale must be one of the available locales in your App CRM installation.
roles	Optional	array	User roles
super_admin	Optional	boolean	Sensitive Indicates whether the user is super admin.
access_api	Optional	boolean	Indicates whether the user can generate API keys and use the API from outside of App CRM. Note that if super_admin is set to true, access to API will be always allowed.
mail_signature	Optional	string
password	Required	string
password_confirmation	Required	string

Update User PUT

Endpoint: https://subdomain.appcrm.com.br/api/users/{id}

Header

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id		integer	The ID of the record

Body Parameters

name	Required	string
email	Required	string
timezone	Required	string	Timezone name from the supported timezones
date_format	Required	string	Accepted values: ['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_format	Required	string	Accepted values: G:i A - AM/PM G:i a - am/pm H:i:s - 24 hours
locale	Required	string	Note The provided locale must be one of the available locales in your App CRM installation.
roles	Optional	array	User roles
super_admin	Optional	boolean	Sensitive Indicates whether the user is super admin.
access_api	Optional	boolean	Indicates whether the user can generate API keys and use the API from outside of App CRM. Note that if super_admin is set to true, access to API will be always allowed.
mail_signature	Optional	string
password	Optional	string	Note If provided, the user password will be updated.

Delete User DELETE

Endpoint: https://subdomain.appcrm.com.br/api/users/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Search Users GET

Endpoint: https://subdomain.appcrm.com.br/api/users/search?q={query}

Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

q	Required	string

Query Parameters

take	Optional	integer	The maximum number of results to query Example: ?take=1
order	Optional	string	Sort the results being queried. Example: ?order=created_at or ?order=created_at|desc
select	Optional	string	Select only the provided fields, useful for query optimization. Example: ?select=first_name;id
search_fields	Optional	string	Change the fields that the search will be performed to Example:?search_fields=email:like;phones.number:=
search_match	Optional	string	By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator. Example: ?search_match=and

Get Logged In User GET

Endpoint: https://subdomain.appcrm.com.br/api/me

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Update Profile PUT

Endpoint: https://subdomain.appcrm.com.br/api/profile

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Body Parameters

name	Required	string
email	Required	string
timezone	Required	string	Timezone name from the supported timezones
date_format	Required	string	Accepted values: ['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_format	Required	string	Accepted values: G:i A - AM/PM G:i a - am/pm H:i:s - 24 hours
locale	Required	string	Note The provided locale must be one of the available locales in your App CRM installation.
roles	Optional	array	User roles
mail_signature	Optional	string

Change Password PUT

Endpoint: https://subdomain.appcrm.com.br/api/profile/password

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Body Parameters

old_password	Required	string	Current Password
password	Required	string	New Password
password_confirmation	Required	string	Confirm New Password