Get partner user details

Overview

Returns the full detail of a single partner user (identified by user_id) including derived user_type, role, assigned locations and assigned accounts. Only partner/account companies may call it, and the target must belong to the caller's company tree (an ownership check).

Prerequisites

• A bearer token in the Authorization header.

Base URL

Endpoint

POST /api/v1/users/partner/details

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Partner / account — collection bearer token. Gate: caller bundle_id ∈ 3; user_id must belong to the caller's company (validation rule).

Rate limit

• No rate limit.

Request body

{
  "user_id": 9
}

How it works

• 200 returns data.response (the user object). user_type is derived from the user's flags: basic when the basic_user flag is set, else assign_brand when the assign_brand flag is set, otherwise admin.
• 404 User not found. when the id resolves to no non-deleted person.
• 403 when the caller is not a partner/account company; 422 when user_id is missing or outside scope.

Response

200 OK · 200

{
  "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"
      ]
    }
  }
}

404 User not found · 404

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

Errors

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": 9}'