Get one user

Overview

Get a user's details, role, and access.

Use this to check or edit a user.

You'll need the user_id.

Returns the user. user_type is the value to send back to Edit a partner user: basic for a basic user, otherwise assign_brand when the user is limited to some accounts, otherwise admin.

Prerequisites

A bearer token. See Authentication.
The user's id (user_id), from List users.

Base URL

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

Endpoint

POST /api/v1/users/partner/details

Authentication

Partner or Account token

user_id must be a user inside your own account tree; otherwise 422.
Any other token (for example a Location token) gets 403.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Notes
`user_id`	integer	Yes	The user to get. Must exist and be inside your account tree.

Request payload

{
  "user_id": 3011
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`response`	object	The user.
`response.id`	integer	The user's id.
`response.first_name`	string	First name.
`response.last_name`	string or null	Last name.
`response.title`	string or null	Job title.
`response.email`	string	The user's email address.
`response.inactive_at`	string or null	When the user is (or was) deactivated. `null` when no deactivation date is set.
`response.email_verified_at`	string or null	When the user's email address was verified.
`response.user_type`	string	`admin`, `assign_brand` or `basic`: the value to send as `user_type` when you edit the user.
`response.role`	string	The user's role label: `Owner`, `Admin User`, `Brand Assigned`, `Location Assigned`, `Basic User` or `User`.
`response.location`	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.
`response.accounts`	array of strings	The names of the accounts assigned to the user. Empty when none are assigned.

Response payload

{
  "data": {
    "status": "success",
    "response": {
      "id": 3011,
      "first_name": "Jane",
      "last_name": "Smith",
      "title": "Manager",
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-09-23T10:43:43.000000Z",
      "user_type": "admin",
      "role": "Owner",
      "location": [],
      "accounts": []
    }
  }
}

Examples

Success payload

A user limited to one account:

{
  "data": {
    "status": "success",
    "response": {
      "id": 9,
      "first_name": "John",
      "last_name": "Doe",
      "title": "Manager",
      "email": "[email protected]",
      "inactive_at": null,
      "email_verified_at": "2026-06-16T12:26:09.000000Z",
      "user_type": "assign_brand",
      "role": "Brand Assigned",
      "location": [],
      "accounts": [
        "Acme Brand"
      ]
    }
  }
}

Error payload

403 Not a partner or account token

{
  "message": "Forbidden",
  "status": "error",
  "errors": "Only partner and brand users are allowed."
}

404 User not found

The user has been removed.

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

422 User outside your tree

{
  "message": "The selected user id does not belong to your company hierarchy.",
  "errors": {
    "user_id": [
      "The selected user id does not belong to your company hierarchy."
    ]
  }
}

422 User doesn't exist

{
  "message": "The selected user id is invalid. (and 1 more error)",
  "errors": {
    "user_id": [
      "The selected user id is invalid.",
      "The selected user id does not belong to your company hierarchy."
    ]
  }
}

422 user_id missing

{
  "message": "The user id field is required.",
  "errors": {
    "user_id": [
      "The user id field is required."
    ]
  }
}

Status	Meaning
`200`	The user.
`401`	The token is missing, expired or invalid.
`403`	The token isn't a Partner or Account token.
`404`	The user has been removed.
`422`	`user_id` is missing, doesn't exist, or is outside your tree.
`500`	Unexpected server error.

Example request

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