User SEARCH

user SEARCH
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

200OK
401Unauthorized
406SSL must be used
500Server Error

RESULT BODY

idThe unique user id. This will be needed when calling other api functions.
usernameThe username.
firstnameThe first name.
lastnameThe last name.
emailThe email address.
phonenumberThe phone number.
isownerIs this user an owner.
isadministratorIs this user an administrator.
datecreatedutcThe date the user was created.
timezoneidThe optional overriding timezone of the user.
permissions
deletecallsCan the user delete calls.
emailcallsCan the user email call recordings.
downloadcallsCan the user download calls.
viewauditsCan the user view audit records.
viewallcallsCan the user view all call records, or only assigned permissions.
exportreportsCan the user exports reports.
viewfinancialsCan the user view financial information.
webinterfaceCan the user use the web interface.
viewcampaignsCan the user use the campaign feature.
modifytagsCan the user modify tags configuration.

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":"paul@calln.com.au","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":"test@test.com","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 

Calculate your CallN Costs in 60 Seconds

  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • After you sign up, this will be used for your Calln domain.
  • A Team member will contact you on this number.
  • A summary of your calculations will be sent to this email address.
  • You may review our terms and conditions and privacy policies by clicking on the links above.