GET api/user?authToken={authToken}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken | string |
Required |
Body Parameters
None.
Response Information
Resource Description
UserModelName | 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": "dcb162be-dffa-483a-aa33-48a5d88e2eb5", "AdsObjectId": "73e0cba4-e0a6-46bd-b386-2de45b37150e", "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-09-15T22:01:24.4070579+00:00", "Status": 1, "CreatedOn": "2025-09-15T22:01:24.4070579+00:00", "CreatedBy": "2450d575-df4c-4879-89d3-e1a697f3a4e9", "ModifiedOn": "2025-09-15T22:01:24.4070579+00:00", "ModifiedBy": "f51aad83-809c-4617-8599-ad4b55e88d88", "DeletedOn": "2025-09-15T22:01:24.4070579+00:00", "DeletedBy": "a79790bd-7990-4e77-9f7d-6cc9459c89fa" }
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>73e0cba4-e0a6-46bd-b386-2de45b37150e</AdsObjectId> <BusinessName>sample string 6</BusinessName> <City>sample string 11</City> <Country>sample string 14</Country> <CreatedBy>2450d575-df4c-4879-89d3-e1a697f3a4e9</CreatedBy> <CreatedOn>2025-09-15T22:01:24.4070579+00:00</CreatedOn> <DeletedBy>a79790bd-7990-4e77-9f7d-6cc9459c89fa</DeletedBy> <DeletedOn>2025-09-15T22:01:24.4070579+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>f51aad83-809c-4617-8599-ad4b55e88d88</ModifiedBy> <ModifiedOn>2025-09-15T22:01:24.4070579+00:00</ModifiedOn> <PasswordChangedOn>2025-09-15T22:01:24.4070579+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>dcb162be-dffa-483a-aa33-48a5d88e2eb5</UserId> <UserKey>1</UserKey> <ZipCode>sample string 13</ZipCode> </UserModel>