---
title: "Search firm staff members"
method: GET
path: "/staff"
tags: ["Staff"]
---

# Search firm staff members

`GET /staff`

## Request

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

Retrieves a paginated list of staff members (filtered based on search parameters provided) in the firm associated with the authenticated client.

## Query parameters

- `Offset` integer
- `Limit` integer
- `Search` string[]
- `Fields` string

## Response `200`

When request is successful. Returns a paged collection of 'Staff' objects.

- StaffPagedCollection
  - `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
  - `value` Staff[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable: Unique identifier of the staff member.
    - `versionId` string, nullable: Version id of the record.
    - `title` string, nullable: Staff member's title.
    - `firstName` string, nullable: Staff member's first name.
    - `middleName` string, nullable: Staff member's middle name (if applicable).
    - `lastName` string, nullable: Staff member's last name.
    - `initials` string, nullable: Staff member's initials.
    - `phone` PhoneNumber
      - `areaCode` string, nullable: Phone area code.
      - `number` string, nullable: Phone number (excluding area code).
    - `cell` PhoneNumber
      - `areaCode` string, nullable: Phone area code.
      - `number` string, nullable: Phone number (excluding area code).
    - `email` string, nullable: Staff member's email address.
    - `role` string, nullable: Staff member's role.
    - `rate` number, double, nullable: Staff member's hourly rate in dollars.
    - `avatar` string, nullable: Staff member's avatar.
    - `former` boolean: Whether he/she is a former member.
    - `enabled` boolean: Whether staff member is enabled.
    - `userId` string, nullable: Staff member's User Id, if enabled.
    - `colorFill` string, nullable: Staff member's fill color hex code.
    - `colorStroke` string, nullable: Staff member's stroke color hex code.
    - `licenceNumbers` LicenceNumber[], nullable: Licence numbers of the staff member.
      - `state` string, nullable: State associated to the licence.
      - `type` string, nullable: Type of the licence.
      - `number` string, nullable: Licence number.
    - `outOfOffice` OutOfOffice
      - `startDate` string, date-time: Out-of-office start date.
      - `endDate` string, date-time: Out-of-office end date.
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

---

[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)