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.
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 can send 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
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
Response Data

Lookup user by username

GET
/users/lookup?username=john.doe
cURL
Copy
Response Data

Lookup multiple users by array of userIDs

POST
/users/lookup
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
GET
users/lookup
Param Value 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.
25
username string Unique username
Access token: *