A user can be retrieve by using the following URL and specifying the user ID.
| Method | URL |
| GET | https://api.fairwarningsoftware.com/v1.1.1/user/[id] |
| Status | Response |
| 200 | { "user_id": <user_id>, "user_active": <user_active>, "user_verified": <user_verified>, "user_requires_password_reset": <user_requires_password_reset>, "user_type": <user_type>, "type_id": <type_id>, "user_mailing_lists": <user_mailing_lists>, "user_is_consignor": <user_is_consignor>, "user_is_referrer": <user_is_referrer>, "user_is_account_exec": <user_is_account_exec>, "user_is_preferred_bidder": <user_is_preferred_bidder>, "user_is_tax_exempt": <user_is_tax_exempt>, "user_tax_id": <user_tax_id>, "user_tax_id_expiration_month": <user_tax_id_expiration_month>, "user_tax_id_expiration_year": <user_tax_id_expiration_year>, "user_tax_id_state": <user_tax_id_state>, "user_reg_date": <user_reg_date>, "user_icon": <user_icon>, "user_email": <user_email>, "user_alt_email": <user_alt_email>, "user_prefix": <user_prefix>, "user_fname": <user_fname>, "user_mname": <user_mname>, "user_lname": <user_lname>, "user_phone": <user_phone>, "user_alt_phone": <user_alt_phone>, "user_fax": <user_fax>, "user_company": <user_company> } |
| 401 | {"error":"The API keys provided are invalid."} |
| 403 | {"error":"API keys are missing."} |
| 500 | {"error": <custom error>} |
| Field | Type | Description |
| user_id | int | The unique identifier for the user |
| user_active | bool | Whether the user account is active |
| user_verified | bool | Whether the user has verified their email address |
| user_requires_password_resest | bool | Whether the user must reset their password after logging in |
| user_type | int | Signifies whether the user is an admin (1) or not (2) |
| type_id | int | Custom user type associated with this user |
| user_mailing_lists | string | A JSON formatted string with the mailing lists this user is registered for |
| user_is_consignor | bool | Whether the user is a consignor |
| user_is_referrer | bool | Whether the user is a referrer |
| user_is_account_exec | bool | Whether the user is an account executive |
| user_is_preferred_bidder | bool | Whether the user is a preferred bidder |
| user_is_tax_exempt | bool | Whether the user is marked as tax exempt |
| user_tax_id | string | The tax ID for the user |
| user_tax_id_expiration_month | int | The month the tax ID expires |
| user_tax_id_expiration_year | int | The year the tax ID expires |
| user_tax_id_state | string | The state in which the tax ID is registered |
| user_reg_date | datetime | The date and time the user registered their account |
| user_icon | string | The image name for the user icon |
| user_email | string | The user's email address |
| user_alt_email | string | An alternate email address for the user |
| user_prefix | string | The user's name prefix |
| user_fname | string | The user's first name |
| user_mname | string | The user's middle name |
| user_lname | string | The user's last name |
| user_phone | string | The user's phone number |
| user_alt_phone | string | An alternate phone number for the user |
| user_fax | string | The user's fax number |
| user_company | string | The user's company name |
User account validation must be taken care of by you. If the user's account is inactive, it is up to you to notify the user that their account is not active. The same for if they need to reset their password or verify their email address. Unless their account is in good standing, they will not be able to place a bid. However, we will not stop them from looking.
You may also retrive the user's address list by passing the flag `get_address_list`, such as:
{ "get_address_list" : true }
This will return a list of addresses associated with the user in-line with the user data.
| Status | Response |
| 200 | { [user-data], "addresses": [ { "address": { "address_type": <address_type>, "address_current": <address_current>, "address_street": <address_street>, "address_street2": <address_street2>, "address_city": <address_city>, "address_state": <address_state>, "address_zip": <address_zip>, "address_country": <address_country> } } ] } |
| Field | Type | Required | Description |
| address_type | int | YES | The type of address: "1" for billing, "2" for shipping. |
| address_current | bool | NO | Whether this is the current address for the address type specified. (Only one current address per type.) |
| address_street | string | YES | The house number and street name. |
| address_street2 | string | NO | The unit/apartment number and prefix. (Apt 3) |
| address_city | string | YES | The city |
| address_state | string | YES | The state abbreviation |
| address_zip | string | YES | The zip code |
| address_country | string | YES | The 2-digit country code. |