Get firm user mapping

Retrieves a user mapping (based on staff or user id parameter provided) in the firm associated with the authenticated client.

GET /firmusers/{id}

Get firm user mapping

cURL

curl --request GET \
  --url https://api.smokeball.com/firmusers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "isFormerUser": false
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string · required

Response

200

application/json

When request is successful. Returns a 'FirmUser' object.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

staffId · string | null

Unique identifier of the staff member.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

userId · string | null

Unique identifier of the user.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

isFormerUser · boolean

Returns true if this user is a former user.

Example:

false