General

Objects

Codes

User GET

Stability: 3 - Frozen

A user is a generic object, which can be used to represent any user across the platform including employees, consumers and developers. In each case a user can be attached to relevant objects via dedicated sub-user objects.

This API GET call allows you to retrieve your user object with full detail.

The endpoint you need to use for this is:

/user

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	GET
x-accept-version	{recommended_latest_version_number}	2

* Required header

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for shopwave server uptime. 200 for success.	int	200

Body

Key	Details	Data Type
user.id	unique user Id	Int
user.firstName	The user's first name.	String
user.lastName	The user's last name.	String
user.email	The user's email address used to sign up.	String
user.employee.roleId	The role of the user within the organisation/merchant.	Int
user.employee.merchantId	The merchant which the user is an employee at.	Int

{
    "user": {
        "id": 273,
        "firstName": "Rich",
        "lastName": "Murray",
        "email": "richard.coffeebean@getshopwave.com",
        "employee": {
            "roleId": 1,
            "merchantId": 30
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "code": "tokenValid",
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "203": {
                    "id": 203,
                    "code": "requestSuccessful",
                    "title": "Request Processed Successfully",
                    "details": "The request has been successfully completed."
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 20
    }
}

Status Codes

Error

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
908	401	Expired Token	Token expired or invalid. Please renew your token
911	401	Authorization Header Invalid	The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken}
912	403	Resource Not Allowed For Specified User	The user does not own this resource and its forbidden
899	500	Unknown Error	Something went wrong. Please contact the site administrator
917	500	Internal Server Error	Something went wrong.

Success

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
203	200	Request Processed Successfully	The request has been successfully completed.
204	204	No content to return	End of the page or no content to return for your request
202	200	Token is valid	Token is validated and found valid.

Request
- Headers
Response
- Headers
- Body
Status Codes
- Error
- Success
Top