Retrieve User

API Documentation

Retrieve User

User

The User API retrieves detailed information about a specific user using their unique ID. This API is useful for accessing user profiles and settings.

Endpoint:

Get /
/api/v1/User/Id

Request Parameters

Id Int (Required)

The ID of the user to retrieve the details.

Response

Id Int(Not Nullable)

The user’s unique identifier

ExternalId String(Nullable)

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

Title String(Nullable)

The user’s title.

FirstName String(Not Nullable)

The user’s first name

MiddleName String(Nullable)

The user’s middle name

LastName String(Not Nullable)

The user’s last name

UserName String(Not Nullable)

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

OrganizationId Int(Not Nullable)

The unique identifier of the organization the user belongs to

CompanyId Int(Nullable)

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

ManagerId Int(Nullable)

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

Disabled Boolean(Not Nullable)

Indicates whether the user account has been disabled

Email String(Not Nullable)

The user’s e-mail address

Phone String(Nullable)

The user’s phone number

Phone2 String(Nullable)

The user’s secondary phone number

Address1 String(Nullable)

First line of the user’s address

Address2 String(Nullable)

Second line of the user’s address

City String(Nullable)

The user’s city

State String(Nullable)

The user’s state

Country String(Nullable)

The user’s country

Zip String(Nullable)

The user’s zip/postal code

ProfileImageUrl String(Nullable)

URL to the user’s profile image

TimeZoneId String(Nullable)

The User’s timezone

SecondaryEmail String(Nullable)

The user’s secondary e-mail address

				
					{
  "success": true,
  "message": "Record retrieved successfully.",
  "data": {
    "Id": 57383,
    "ExternalId": "C9876ZFGEFER9876",
    "Title": "mr",
    "FirstName": "John",
    "MiddleName": "tanss",
    "LastName": "Smith",
    "UserName": "john.smith",
    "OrganizationId": 4873,
    "CompanyId": 23456,
    "ManagerId": 987623,
    "Disabled": false,
    "Email": "joe.smith@test.com",
    "Phone": 9876543212,
    "Phone2": 9282726526,
    "Address1": "home123 ,Newyork",
    "Address2": "home 234. newyork",
    "City": "newyork",
    "State": "manhattan",
    "Country": "newyork",
    "Zip": null,
    "ProfileImageUrl": null,
    "TimeZoneId": "Central Standard Time",
    "SecondaryEmail": "joe2.smith@test.com",
    "Roles": [
      0,
      2
    ],
    "ManagedOrganizations": []
  }
}