Skip to main content
GET
/
firmusers
Get firm user mappings
curl --request GET \
  --url https://api.smokeball.com/firmusers \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
[
  {
    "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

Response

When request is successful. Returns an array of one or more 'FirmUser' objects.

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET
ā€‹
self
object
ā€‹
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