Users

User List

Get a list of users in the system

HTTP Request

[GET] /api/v6/users

Query Parameters

Fields

Fields	Type	Description
user_id	integer	User identifier
contact_id	integer	Contact identifier
contact_name	string	User name
dept_id	integer	Department identifier
dept_name	string	Department name
email	string	User email
contact_mobile	numeric	User phone
extensions	object	User extension number

Filtering

Fields	Support	Type	Description
user_id	eq,in	integer	Identifier
valid	eq	integer	Valid or not
contact_name	eq,contains	string	User name
email	eq,contains	string	User email
contact_mobile	eq,contains	numeric	User phone

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/users?fields=contact_name&filtering[id]=2&filtering[contact_name:contains]=Lê&limit=1&offset=1 HTTP/1.1
Host: example.getflycrm.com
Authorization: Bearer token

Status

200 OK

Response

{
  "data": [
    {
      "user_id": 3,
      "contact_id": 2,
      "contact_name": "Le Van Duy",
      "dept_id": 4,
      "dept_name": "Administration - HR",
      "email": "[email protected]",
      "contact_mobile": "",
      "extensions": {
        "VFONE": "212",
        "CALLIO": "3333",
        "EPACIFICV2": "4444"
      }
    }
  ],
  "has_more": true,
  "offset": 1,
  "limited": 1
}