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 | Description | 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. |
|
| 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": "bf9beb85-0249-45f9-b78b-036d6ddaf5d5",
"AdsObjectId": "3b749fd9-bdd7-4507-89f2-f6615805b8ab",
"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-12-14T15:29:37.6609255+00:00",
"Status": 1,
"CreatedOn": "2025-12-14T15:29:37.6609255+00:00",
"CreatedBy": "1daea680-cba4-4fc1-9611-22cf277961d9",
"ModifiedOn": "2025-12-14T15:29:37.6609255+00:00",
"ModifiedBy": "0f436fb1-797b-482d-bd88-6496b23a185f",
"DeletedOn": "2025-12-14T15:29:37.6609255+00:00",
"DeletedBy": "bdebffb0-878e-441c-bc01-7958e3441609"
}
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>3b749fd9-bdd7-4507-89f2-f6615805b8ab</AdsObjectId> <BusinessName>sample string 6</BusinessName> <City>sample string 11</City> <Country>sample string 14</Country> <CreatedBy>1daea680-cba4-4fc1-9611-22cf277961d9</CreatedBy> <CreatedOn>2025-12-14T15:29:37.6609255+00:00</CreatedOn> <DeletedBy>bdebffb0-878e-441c-bc01-7958e3441609</DeletedBy> <DeletedOn>2025-12-14T15:29:37.6609255+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>0f436fb1-797b-482d-bd88-6496b23a185f</ModifiedBy> <ModifiedOn>2025-12-14T15:29:37.6609255+00:00</ModifiedOn> <PasswordChangedOn>2025-12-14T15:29:37.6609255+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>bf9beb85-0249-45f9-b78b-036d6ddaf5d5</UserId> <UserKey>1</UserKey> <ZipCode>sample string 13</ZipCode> </UserModel>