List Users

The List Users API will allow you to fetch a list of users within Zenput.

Below is a sample call and a full description of input parameters, and success and error output formats.

$ curl -H 'X-API-TOKEN: <API_TOKEN>' \
    'https://www.zenput.com/api/v1/users/list_users/?start=0&limit=10'

Input parameters
All input parameters are optional.

Name	Type	Description
group_id	integer	Limit list to users within given group id.
search_query	text	Query to search first name and last name.
start	integer	The index of the first row to return, used with limit, to define a page of results.
limit	integer	The number of users to return, used with start, to define a page of results. The default value is 100.
order_by	One of `"first_name"`, `"last_name"`, `"email"`, `"date_redeemed"`	Sort order of result. A value may be prefixed by a `-` to specify a descending sort.
count	boolean	If `true`, result will include a count of found users without regard to any start or limit values.

Output format, success

{
    "status": 200,
    "count": count-of-users-found,
    "results": [
      {},
      ...
      {}
    ],
    "success": true
}

Output format, failure

{
    "status": 500,
    "message": "Cannot get user list",
    "exception": "Technical error details appear here",
    "success": false
}