A User resource represents a single user within a given site. This may be a contact in either the “Deleted” or “Active” status. The User list resource represents a set of users in a given site.
HTTP GET
GET /api/2013-12-01/Users
Returns a list of users for your site.
Paging
Paging can be accomplished by passing the Page request parameter. By default, only 100 users are returned per request. You can use the Page_Size request parameter to specify up to 10,000 users per request.
List Filters
The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.
| Parameter | Description |
|---|---|
| Name | Filter users with a matching Name. The % character can be used to designate a wildcard. |
| Username | Filter users with a matching Username. The % character can be used to designate a wildcard. |
| Filter users with a matching Email. The % character can be used to designate a wildcard. | |
| Status | Only show users that are in either the “Active” or “Deleted” status. Defaults to “Active”. |
Example Request
Fetch the entire list.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Users \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-01-15T22:39:58+00:00",
"users": [
{
"2FA": "Enabled",
"Caller ID": 18132897620,
"Cell": null,
"Desk": 18132897620,
"Email": 'john@readyop.com',
"Language": 'en',
"Name": "John Doe",
"Status": "Active",
"User ID": 1234,
"Username": "JohnD"
}, ...
],
"results": 123,
"pages": 2,
"page": 1,
"page_start": 100,
"page_end": 122,
"page_size": 100
}
Example Request
Show only those users who’s Name field begins with “John”.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Users \
-d "Name=John%" \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-01-15T22:39:58+00:00",
"users": [
{
"2FA": "Enabled",
"Caller ID": 18132897620,
"Cell": null,
"Desk": 18132897620,
"Email": 'john@readyop.com',
"Language": 'en',
"Name": "John Doe",
"Status": "Active",
"User ID": 1234,
"Username": "JohnD"
}, ...
],
"results": 123,
"pages": 2,
"page": 1,
"page_start": 100,
"page_end": 122,
"page_size": 100
}