Get a List of Users

The Get the List of Users method returns a List of Users created in ActivePlatform.

GET /api/vendor/v1/users.json?api_token={api_token}

Arguments

Name	Parameter Type	Data type	Required/ Optional	Description
api_token	query	string	Required	API token of the manager who perform the operation (see API Token Authentication)
page	query	integer	Optional	Returns the page with mentioned number
per_page	query	integer	Optional	Setting a number of items in the page
sorting[field]	query	string	Optional	Sorting the list by a specified field
sorting[reversed]	query	string	Optional	Set the reversed sorting mode by the specified field: true — descending sorting. false — ascending sorting (by default).
filters[created_at]	query	date	Optional	Filtering the list by a creation date
filters[updated_at]	query	date	Optional	Filtering the list by an update date
filters[status]	query	string	Optional	Filtering the list by a status
filters[email]	query	string	Optional	Filtering list by user's email

GET /api/vendor/v1/users.json?api_token={api_token}

Response model

Name	Data type	Description
id	integer	A unique identification number of the user
first_name	string	The first name for the user
middle_name	string	The middle name for the user
last_name	string	The last name for the user
email	string	An email of the user, which is used as a login
status	string	A user's status for all Accounts, to which it was linked: active or inactive
custom_attributes	array	A list of additional attributes (see Managing attributes in the ActivePlatform. Operator Control Panel): name — a name of the attribute. value — a value of the attribute.
created_at	date	A date and time of user creation
updated_at	date	A date and time of the last update of the user information

Request example

GET http://billing.activeplatform.com:80/api/vendor/v1/users?api_token=654321&sorting[reversed]=true

Response example

[
  {
    "id": 2002984,
    "first_name": "Oleg",
    "middle_name": "",
    "last_name": "Ivanov",
    "email": "mario@activeplatform.com",
    "status": "active",
    "custom_attributes": [],
    "created_at": "2016-10-03T05:15:22.286+03:00",
    "updated_at": "2016-10-03T05:16:19.243+03:00"
  },
  {
    "id": 2002983,
    "first_name": "John",
    "middle_name": "J",
    "last_name": "Doe",
    "email": "john.doe@activeplatform.com",
    "status": "active",
    "custom_attributes": [],
    "created_at": "2016-08-15T08:15:22.549+03:00",
    "updated_at": "2016-08-15T08:15:22.549+03:00"
  }
]