Skip to content

Get Accounts by User

This endpoint is used to get accounts associated with User By UserUUID

Request

GET /users/{user-uuid}/accounts
  • user-uuid is a 22-character identifier for the user

Authorization

Authorization is required

Headers

N/A

Query Parameters

Parameter Required More Info
continuation-token no Send this parameter if the response of the previous request provided a continuation token in the result

continuation-token

On first request, if there is more data, a continuation token will be provided in the result. Specify that token in the next request a the continaution-token query parameter and the next page of data will be provided

fields

Here are the fields that can be provided:

  • name
  • address
  • phone

Response

Response Status Code More Information
Success 200 If the response is successful
Unauthorized 401 If user is not authorized for the requested user
Internal Server Error 500 Unknown error

Headers

N/A

Body

A paged response, with rows and an optional continuation token:

{
    "data": {
        "items": [
            { 
                "uuid": "<account-uuid>",
                "name": "Account 0",
                "address": "Address 0",
                "phone": "Phone 0",
            },
            {
                //item 2
            },
            {
                //item n
            }
        ],
        "continuationToken": "<continuation-token",
        "totalCount": 0
    }
}