List users

Overview

Get the users at your partner (or an account) with their role and what they can access.

Use this to manage your team.

You'll need a partner or account token.

Returns one entry per user. The list isn't paginated: every user in the company of the user behind the token comes back in one response.

Prerequisites

A bearer token. See Authentication.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/users/list

Authentication

Partner or Account token

Lists the users in the company of the user behind the token: your partner for a Partner token, your account for an Account token.
Any other token (for example a Location token) gets 403.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`sort_field`	query	string	No	Sort the list by `email`, `first_name`, `last_name` or `role`. Leave it out to keep the default order.
`sort_by`	query	string	No	`ASC` or `DESC` (either case). Only used with `sort_field`. Default `ASC`.

Request body

None.

Request payload

None.

Response body

The payload is an array inside data.

Field	Type	Description
`data[].id`	integer	The user's id. Use it as `user_id` or `user` in the other user calls.
`data[].email`	string	The user's email address.
`data[].inactive_at`	string or null	When the user is (or was) deactivated. `null` when no deactivation date is set.
`data[].email_verified_at`	string or null	When the user's email address was verified.
`data[].first_name`	string	First name.
`data[].last_name`	string or null	Last name.
`data[].role`	string	The user's role: `Owner`, `Admin User`, `Brand Assigned`, `Location Assigned`, `Basic User` or `User`.
`data[].locations`	array of strings	The active or pending locations assigned to the user, each as the location's name followed by `-` and its `client_location_id` (or its `storeid` when it has no `client_location_id`). Empty when none are assigned.
`data[].accounts`	array of strings	The names of the accounts assigned to the user. Empty when none are assigned.

Response payload

{
  "data": [
    {
      "id": 3011,
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-09-23T10:43:43.000000Z",
      "first_name": "Jane",
      "last_name": "Smith",
      "role": "Owner",
      "locations": [],
      "accounts": []
    }
  ]
}

Examples

Success payload

A partner with an owner and a user assigned to one account:

{
  "data": [
    {
      "id": 5,
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-06-12T06:28:19.000000Z",
      "first_name": "Alex",
      "last_name": "Smith",
      "role": "Basic User",
      "locations": [],
      "accounts": []
    },
    {
      "id": 3,
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-06-11T10:34:52.000000Z",
      "first_name": "John",
      "last_name": "Doe",
      "role": "Owner",
      "locations": [],
      "accounts": [
        "Acme Brand"
      ]
    }
  ]
}

Error payload

403 Not a partner or account token

{
  "message": "Forbidden",
  "status": "error",
  "errors": "Only Brand users are allowed."
}

422 Invalid sort field

{
  "message": "The selected sort field is invalid.",
  "errors": {
    "sort_field": [
      "The selected sort field is invalid."
    ]
  }
}

422 Invalid sort direction

{
  "message": "The selected sort by is invalid.",
  "errors": {
    "sort_by": [
      "The selected sort by is invalid."
    ]
  }
}

Status	Meaning
`200`	The users in your company.
`401`	The token is missing, expired or invalid.
`403`	The token isn't a Partner or Account token.
`422`	`sort_field` or `sort_by` isn't one of the allowed values.
`500`	Unexpected server error.

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/users/list?sort_field=last_name&sort_by=ASC" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Updated 17 days ago

Did this page help you?