Returns information about a particular user as a User Info object.
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the query string of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
UserID | integer | positive # | The user id belonging to the user you are looking up. |
UserName | string | string | User name to the user you are looking up. |
If the user credentials are not for an active user, you will recieve a 403 Forbidden
and a Message Response indicating the reason
If the user credentials are for an active user, you will receive a 200 OK
and the following data as serialized JSON
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
UserID | integer | integer | The user's identifier. |
UserName | string | string | The UserName of the user. |
string | string | The email belonging to the user. | |
CompanyName | string | string | The company name associated with the user. |
FirstName | string | string | The first name of the user. |
LastName | string | string | The last name of the user. |
Address1 | string | string | The first line of the user's address. |
Address2 | string | string | The second line of the user's address. |
City | string | string | The city of the user. |
State | string | string | The state of the user. |
PostalCode | string | string | The postal code of the user. |
CountryCode | string | string | The country code of the user. |
Phone | string | string | The primary phone number of the user. |
AlternatePhone | string | string | The alternate phone number of the user. |
FaxPhone | string | string | The fax phone number of the user. |
IsBusinessAddress | boolean | true/false | If true, then the address is for a business. |
Over21 | boolean | true/false | If true, the user is 21 years of age or older. |