Retrieve user information by id

Prev Next
Get
/GetUser/{id}

Allows you to get information about a user (user object) with the given ID.

Security
API Key
Header parameter nameapi_key
Path parameters
id
integer (int32) Required

The ID of the user to retrieve

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example0
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

User
object (User)
Id
integer (int32)

The user's unique identifier

Example57383
ExternalId
string | null

The user's external ID, usually a unique identifier from the calling system

ExampleC9876ZFGEFER9876
Title
string | null

The user's title

FirstName
string

The user's first name

ExampleJohn
MiddleName
string | null

The user's middle name

LastName
string

The user's last name

ExampleSmith
UserName
string

The user's username (used during sign-in)

Examplejohn.smith
OrganizationId
integer (int32)

The unique identifier of the organization the user belongs to

Example4873
CompanyId
integer (int32) | null

The Id of the user's company (set only if the user belongs to a company)

ManagerId
integer (int32) | null

The user Id of the user's manager (set only if the user belongs to a manager)

Disabled
boolean

Indicates whether the user account has been disabled

ExampleFalse
Email
string

The user's e-mail address

Examplejoe.smith@yourorg.com
Phone
string | null

The user's phone number

Phone2
string | null

The user's secondary phone number

Address1
string | null

First line of the user's address

Address2
string | null

Second line of the user's address

City
string | null

The user's city

State
string | null

The user's state

Country
string | null Deprecated

The user's country.

CountryCode
string | null

The 2-character code for the user's country

Zip
string | null

The user's zip/postal code

ProfileImageUrl
string | null

URL to the user's profile image

TimeZoneId
string | null

The User's timezone

Roles
Array of integer

Identifiers of roles the user belongs to

Example[ "0", "2" ]
integer (int32)
ManagedOrganizations
Array of integer

Identifiers of organizations the user has management rights to

Example[]
integer (int32)
CustomFields
Array of object

Custom Fields that have values for the user

Example[ { "Name": "Core Id", "TextValue": "AXY12345", "CustomFieldId": 5080 }, { "Name": "Blood Type", "TextValue": "A+", "CustomFieldId": 5081 } ]
object
string