Users

Searching for users

You can search for users in a given company by passing valid search criteria. The search criteria can usually be any of the following user elements (field names) and will be sent as part of the URI as query parameters:

  • First Name
  • Last Name
  • Title
  • Job Title
  • Country
  • Timezone
  • Organization Name
  • Division
  • Business Unit
  • Department
  • Team Name
  • Role
  • Additional Team Name
  • Additional Role
  • Work Email Address 1
  • Work Mobile Phone 1
  • Work Phone Area Code 1
  • Work Phone 1
  • Status*

*When searching for users based on their status, use the short code ‘A’ for ACTIVE, ‘I’ for INACTIVE and so on, rather than the full word. That is, &status=A, not &status=ACTIVE.

This searching mechanism can be useful for checking if any users exist in the system with a specific email address, phone number, job role and so on.

The key parameters that are required in the URL to facilitate the search are as follows:

URI request elements as query params

fieldname

String

Specifies on this field name of the user object.

Example:
http://api..whispir.com/users?apikey=&firstName=Sam

sortOrder

String

The order in which you require the results to be returned. Either ‘asc’ or ‘desc’.

sortFields

String

The fields that you require the ordering to be performed on. Multiple fields can be provided, separated by a comma.

Example:
http://api..whispir.com/users?apikey=&firstName=Sam&sortFields=lastName,jobTitle


  • JSON
  • XML

Searching for users

Users can easily use further query parameters to search for specific users within Whispir.

HTTP 1.1 GET https://api.<region>.whispir.com/users?apikey=<your_api_key>&firstName=Sam&sortOrder=desc&sortFields=workEmailAddressPrimary
Authorization: Basic am9obi5zbWl0aDpteXBhc3N3b3Jk
x-api-key: your_api_key
Accept: application/vnd.whispir.user-v1+json