---
title: "Get firm user mappings"
method: GET
path: "/firmusers"
tags: ["Firm"]
---

# Get firm user mappings

`GET /firmusers`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/firmusers`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Retrieves a list of user mappings in the firm associated with the authenticated client.

## Response `200`

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

- FirmUser[]
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `staffId` string, nullable: Unique identifier of the staff member.
  - `userId` string, nullable: Unique identifier of the user.
  - `isFormerUser` boolean: Returns true if this user is a former user.

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)