SMsmokeball
Firm

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}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/firmusers/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
staffIdstring nullable

Unique identifier of the staff member.

userIdstring nullable

Unique identifier of the user.

isFormerUserboolean

Returns true if this user is a former user.

Example response

{
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.