get
https://production-api.shoutaboutus.com/api/v1/users/list
List every non-deleted user in the authenticated caller's company with their role, assigned locations and assigned accounts. Only partner (bundle_id=1) and account (bundle_id=3) companies may call it.
Auth
- Partner / account company-admin — collection bearer token. In-controller gate: the caller's company
bundle_idmust be 1 or 3, else403 Only Brand users are allowed.
Rate limit
- No rate limit.
Query
| Field | Type | Required | Notes |
|---|---|---|---|
sort_field | string | Optional | One of email, first_name, last_name, role. |
sort_by | string | Optional | ASC / DESC (case-insensitive). Only applied when sort_field is present. |
Behaviour
200returns adataarray of users (id, email, verification/active state, name, role,locations,accounts). Not paginated — returns the full company user list.403when the caller is not a partner/account company.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…