Get account user

Overview

Returns a single user's profile, derived user_type, role, assigned locations (as {value, label} options) and assigned accounts. user_id must belong to the caller's company (an ownership check).

Prerequisites

A bearer token in the Authorization header.

Base URL

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

Endpoint

POST /api/v1/user/get

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Authenticated account user — collection bearer token.
The endpoint scopes user_id to the caller's company by the validation rule.

Rate limit

No rate limit.

Request body

Field	Type	Required	Description
`user_id`	integer	Required	Id of the user to retrieve; must belong to the caller's company.

{
  "user_id": 12
}

How it works

200 returns data.response. location/accounts are {value, label} option objects for form pre-fill.
404 User not found. when the id resolves to no user.
422 when user_id is missing or outside scope.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "response": {
      "id": 12,
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-06-16T12:26:09.000000Z",
      "title": "Manager",
      "user_type": "location_assign",
      "role": "Location Assigned",
      "location": [
        {
          "value": 12,
          "label": "Downtown Store (LOC-12)"
        }
      ],
      "accounts": [
        {
          "value": 13,
          "label": "Acme Brand (ACC-13)"
        }
      ]
    }
  }
}

404 User not found · `404`

{
  "message": "Not Found",
  "status": "error",
  "errors": "User not found."
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`404`	User not found
`422`	Returned when `user_id` is missing or outside scope
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/user/get" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"user_id": 12}'

Updated 11 days ago

Did this page help you?