GET api/user?authToken={authToken}

Request Information

URI Parameters

Name	Description	Type	Additional information
authToken		string	Required

Body Parameters

None.

Response Information

Resource Description

UserModel

Name	Type	Additional information
UserKey	integer	None.
UserId	globally unique identifier	None.
AdsObjectId	globally unique identifier	None.
FirstName	string	None.
LastName	string	None.
BusinessName	string	None.
Email	string	None.
Phone	string	None.
PhoneCode	string	None.
Address	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
Country	string	None.
MFAEnabled	boolean	None.
MFAType	integer	None.
ResetPassword	boolean	None.
PasswordChangedOn	date	None.
Status	integer	None.
CreatedOn	date	None.
CreatedBy	globally unique identifier	None.
ModifiedOn	date	None.
ModifiedBy	globally unique identifier	None.
DeletedOn	date	None.
DeletedBy	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "UserKey": 1,
  "UserId": "311ddcb4-1c36-46a0-a493-71af8b496850",
  "AdsObjectId": "1b35a46a-8e98-45a4-9d6c-114a04ff2324",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "BusinessName": "sample string 6",
  "Email": "sample string 7",
  "Phone": "sample string 8",
  "PhoneCode": "sample string 9",
  "Address": "sample string 10",
  "City": "sample string 11",
  "State": "sample string 12",
  "ZipCode": "sample string 13",
  "Country": "sample string 14",
  "MFAEnabled": true,
  "MFAType": 1,
  "ResetPassword": true,
  "PasswordChangedOn": "2025-06-13T13:51:15.8625261+00:00",
  "Status": 1,
  "CreatedOn": "2025-06-13T13:51:15.8625261+00:00",
  "CreatedBy": "3eabce24-e6cf-462c-91e3-c2e301e4dfb2",
  "ModifiedOn": "2025-06-13T13:51:15.8625261+00:00",
  "ModifiedBy": "2361360b-7e25-4fc5-859d-57c336fd171e",
  "DeletedOn": "2025-06-13T13:51:15.8625261+00:00",
  "DeletedBy": "acaf3157-33a0-40cf-863d-2596ec0b835d"
}

application/xml, text/xml

Sample:

<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <Address>sample string 10</Address>
  <AdsObjectId>1b35a46a-8e98-45a4-9d6c-114a04ff2324</AdsObjectId>
  <BusinessName>sample string 6</BusinessName>
  <City>sample string 11</City>
  <Country>sample string 14</Country>
  <CreatedBy>3eabce24-e6cf-462c-91e3-c2e301e4dfb2</CreatedBy>
  <CreatedOn>2025-06-13T13:51:15.8625261+00:00</CreatedOn>
  <DeletedBy>acaf3157-33a0-40cf-863d-2596ec0b835d</DeletedBy>
  <DeletedOn>2025-06-13T13:51:15.8625261+00:00</DeletedOn>
  <Email>sample string 7</Email>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <MFAEnabled>true</MFAEnabled>
  <MFAType>1</MFAType>
  <ModifiedBy>2361360b-7e25-4fc5-859d-57c336fd171e</ModifiedBy>
  <ModifiedOn>2025-06-13T13:51:15.8625261+00:00</ModifiedOn>
  <PasswordChangedOn>2025-06-13T13:51:15.8625261+00:00</PasswordChangedOn>
  <Phone>sample string 8</Phone>
  <PhoneCode>sample string 9</PhoneCode>
  <ResetPassword>true</ResetPassword>
  <State>sample string 12</State>
  <Status>1</Status>
  <UserId>311ddcb4-1c36-46a0-a493-71af8b496850</UserId>
  <UserKey>1</UserKey>
  <ZipCode>sample string 13</ZipCode>
</UserModel>