GET /API/USER/
Search for users(s) within the search criteria.
QUERY STRING PARAMETERS
| afterid optional | After retrieving a previous result set, include only records after the previous maximum id. |
|---|---|
| maxresults optional | The maximum amount of records to return. The default value is 100 with a maximum value of 1,000. |
| username optional | Only return records with this username. |
| firstname optional | Only return records with this first name. |
| lastname optional | Only return records with this last name. |
| email optional | Only return records with this email address. |
RESULT CODE
| 200 | OK |
|---|---|
| 401 | Unauthorized |
| 406 | SSL must be used |
| 500 | Server Error |
RESULT BODY
| id | The unique user id. This will be needed when calling other api functions. |
||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| username | The username. |
||||||||||||||||||||
| firstname | The first name. |
||||||||||||||||||||
| lastname | The last name. |
||||||||||||||||||||
The email address. |
|||||||||||||||||||||
| phonenumber | The phone number. |
||||||||||||||||||||
| isowner | Is this user an owner. |
||||||||||||||||||||
| isadministrator | Is this user an administrator. |
||||||||||||||||||||
| datecreatedutc | The date the user was created. |
||||||||||||||||||||
| timezoneid | The optional overriding timezone of the user. |
||||||||||||||||||||
| permissions |
|
EXAMPLE REQUEST
Example;-
GET
https://api.calln.com/api/user?firstname=paul&maxresults=5
Result;-
200 (OK)
[{"id":3182,"username":"paul","firstname":"Paul","lastname":"Johansen","email":"[email protected]","phonenumber":"","isowner":true,"isadministrator":true,"datecreatedutc":"2015-01-02T21:16:21.56","timezoneid":null,"permissions":{"deletecalls":true,"emailcalls":true,"downloadcalls":true,"viewaudits":true,"viewallcalls":true,"exportreports":true,"viewfinancials":false,"webinterface":true,"reportall":true,"viewcampaigns":false,"modifytags":false}},{"id":4507,"username":"paulgreen","firstname":"Paul","lastname":"Green","email":"[email protected]","phonenumber":"","isowner":false,"isadministrator":false,"datecreatedutc":"2014-05-15T05:14:48.017","timezoneid":null,"permissions":{"deletecalls":true,"emailcalls":true,"downloadcalls":true,"viewaudits":true,"viewallcalls":true,"exportreports":true,"viewfinancials":false,"webinterface":true,"reportall":true,"viewcampaigns":false,"modifytags":true}}]
USING CURL
curl "https://api.calln.com/api/user?firstname=paul&maxresults=5" -H "Authorization: Basic username:password | base64" -X GET
