POST GET users/search

Search users by various criteria

* required

Parameters

Name	Type	Description
lastName	string
email	string
userIDs	array[integer]	Multiple userIDs
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50

Response Data

Name	Type	Description
userID	integer	Unique ID of a user
username	string	Unique username
firstName	string
lastName	string
title	string
email	email-address
dateAdded	datetime	Date record was added
dateModified	datetime	Date record was modified

Permissions

Method requires the Client admin permission

Example Calls

All users

GET

/users/search

cURL

Copy

curl https://api.emailer.emfluence.com/v1/users/search \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":2,"prev":""},"records":[{"firstName":"John","dateAdded":"2013-01-07 17:10:00","username":"john.doe","email":"john.doe@example.com","dateModified":"2014-03-24 21:10:00","title":"Marketing Manager","userID":123,"lastName":"Doe"},{"firstName":"Jane","dateAdded":"2013-01-07 17:10:00","username":"jane.doe","email":"jane.doe@example.com","dateModified":"2014-03-24 21:10:00","title":"Sales Manager","userID":123,"lastName":"Doe"}]},"code":0,"requestID":"5BF99520-36AA-49BC-814D9466353304FA"}

Search by last name

GET

/users/search?lastName=doe

cURL

Copy

curl https://api.emailer.emfluence.com/v1/users/search?lastName=doe \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":2,"prev":""},"records":[{"firstName":"John","dateAdded":"2013-01-07 17:10:00","username":"john.doe","email":"john.doe@example.com","dateModified":"2014-03-24 21:10:00","title":"Marketing Manager","userID":123,"lastName":"Doe"},{"firstName":"Jane","dateAdded":"2013-01-07 17:10:00","username":"jane.doe","email":"jane.doe@example.com","dateModified":"2014-03-24 21:10:00","title":"Sales Manager","userID":123,"lastName":"Doe"}]},"code":0,"requestID":"C16931BC-EF02-431F-8D632BC5F1CF74A5"}

API Console

The console uses production data, so BE CAREFUL!

GET

users/search

Param	Type	Description
lastName	string
email	string
userIDs	array[integer]	Multiple userIDs
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50

Access token: *

Users

POST GET users/search

Parameters

Response Data

Permissions

Example Calls

All users

Search by last name

API Console