POST GET users/lookup

Get full details for users by ID or username

* required

Parameters

Name	Type	Description
userID	integer	Unique ID of a user
userIDs	array[integer]	Multiple userIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25
username	string	Unique username

Response Data

Returns a fully populated user object, or an array of user objects if looking up multiple userIDs

Name	Type	Description
address1	string
address2	string
businessHours	string
businessUnit	string
city	string
company	string
dateAdded	datetime	Date record was added
dateModified	datetime	Date record was modified
email	email-address
fax	string
firstName	string
groupIDs	array[integer]	Groups user has access to
lastName	string
permissions	array	Permissions granted to user
phone	string
phone2	string
region	string
state	string
team	string
templateIDs	array[integer]	Email templates user has access to
title	string
url	string
userID	integer	Unique ID of a user
username	string	Unique username
zip	string

Example Calls

Lookup user by ID

GET

/users/lookup?userID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/users/lookup?userID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"company":"emfluence","businessUnit":"","state":"MO","dateAdded":"2012-01-07 17:10:00","permissions":["Client Administrator","Send Mail","Compose Mail","Create Groups","Contacts (Delete)","Contacts (Add)","Contacts (Edit)","Contacts (Import)","Contacts (Export)","Manage Signatures","Upload Images","Pre-Flight","Content Blocks","Manage Landing Pages","Connections Admin","Social Media Contributor","Survey Admin","Survey Viewer"],"phone2":"","dateModified":"2014-03-24 21:10:23","address2":"Suite 2220","phone":"816-555-5643 x107","firstName":"John","zip":64105,"address1":"106 w 11th st","businessHours":"","email":"john.doe@example.com","username":"john.doe","city":"Kansas City","region":"MO","fax":"","team":"","listIDs":[123,456,789],"templateIDs":[123,456],"lastName":"Doe","userID":123,"title":"Marketing Manager","url":""},"code":0,"requestID":"00A577FE-6230-474C-99595A18BCA00CA4"}

Lookup user by username

GET

/users/lookup?username=john.doe

cURL

Copy

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

Response Data

{"success":1,"data":{"company":"emfluence","businessUnit":"","state":"MO","dateAdded":"2012-01-07 17:10:00","permissions":["Client Administrator","Send Mail","Compose Mail","Create Groups","Contacts (Delete)","Contacts (Add)","Contacts (Edit)","Contacts (Import)","Contacts (Export)","Manage Signatures","Upload Images","Pre-Flight","Content Blocks","Manage Landing Pages","Connections Admin","Social Media Contributor","Survey Admin","Survey Viewer"],"phone2":"","dateModified":"2014-03-24 21:10:23","address2":"Suite 2220","phone":"816-555-5643 x107","firstName":"John","zip":64105,"address1":"106 w 11th st","businessHours":"","email":"john.doe@example.com","username":"john.doe","city":"Kansas City","region":"MO","fax":"","team":"","listIDs":[123,456,789],"templateIDs":[123,456],"lastName":"Doe","userID":123,"title":"Marketing Manager","url":""},"code":0,"requestID":"B9C47541-3ABD-4D34-A3333953772CE734"}

Lookup multiple users by array of userIDs

POST

/users/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/users/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"userIDs": [123,456,789]
	}'

Response Data

{"success":1,"data":[{"company":"emfluence","businessUnit":"","state":"MO","dateAdded":"2012-01-07 17:10:00","permissions":["Client Administrator","Send Mail","Compose Mail","Create Groups","Contacts (Delete)","Contacts (Add)","Contacts (Edit)","Contacts (Import)","Contacts (Export)","Manage Signatures","Upload Images","Pre-Flight","Content Blocks","Manage Landing Pages","Connections Admin","Social Media Contributor","Survey Admin","Survey Viewer"],"phone2":"","dateModified":"2014-03-24 21:10:23","address2":"Suite 2220","phone":"816-555-5643 x107","firstName":"John","zip":64105,"address1":"106 w 11th st","businessHours":"","email":"john.doe@example.com","username":"john.doe","city":"Kansas City","region":"MO","fax":"","team":"","listIDs":[123,456,789],"templateIDs":[123,456],"lastName":"Doe","userID":123,"title":"Marketing Manager","url":""},{"company":"emfluence","businessUnit":"","state":"MO","dateAdded":"2013-08-19 10:19:00","permissions":["Send Mail","Compose Mail","Contacts (Delete)","Contacts (Add)","Contacts (Edit)","Contacts (Import)","Contacts (Export)","Upload Images","Content Blocks","Manage Landing Pages","Survey Viewer"],"phone2":"","dateModified":"2013-08-19 10:19:00","address2":"Suite 2220","phone":"816-555-5643 x108","firstName":"Jane","zip":64105,"address1":"106 w 11th st","businessHours":"","email":"jane.doe@example.com","username":"jane.doe","city":"Kansas City","region":"MO","fax":"","team":"","listIDs":[],"templateIDs":[],"lastName":"Doe","userID":456,"title":"Sales","url":""},{"company":"emfluence","businessUnit":"","state":"MO","dateAdded":"2015-01-19 09:00:00","permissions":["Send Mail","Compose Mail","Upload Images","Content Blocks","Manage Landing Pages","Survey Viewer"],"phone2":"","dateModified":"2015-01-19 09:00:00","address2":"Suite 2220","phone":"816-555-5643 x109","firstName":"Bob","zip":64105,"address1":"106 w 11th st","businessHours":"","email":"bob.smith@example.com","username":"bob.smith","city":"Kansas City","region":"MO","fax":"","team":"","listIDs":[],"templateIDs":[],"lastName":"Bob","userID":789,"title":"Producer","url":""}],"code":0,"requestID":"6689C68F-FD24-4F2D-A68D93FA6D4FA349"}

API Console

The console uses production data, so BE CAREFUL!

GET

users/lookup

Param	Type	Description
userID	integer	Unique ID of a user
userIDs	array[integer]	Multiple userIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25
username	string	Unique username

Access token: *

Users

POST GET users/lookup

Parameters

Response Data

Example Calls

Lookup user by ID

Lookup user by username

Lookup multiple users by array of userIDs

API Console