---
title: "Search invitations"
method: GET
path: "/invitations"
tags: ["Invitations"]
---

# Search invitations

`GET /invitations`

## Request

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

Lists the firm's invitations, most recently expiring first. Only pending invitations are
returned unless `status` says otherwise.

## Query parameters

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

## Response `200`

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

- InvitationPagedCollection: A page of invitations.
  - `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` Invitation[], 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 invitation.
    - `email` string, nullable: Email address the invitation was sent to.
    - `status` string: Pending, Accepted (the person registered with the firm), Expired or Cancelled.
    - `expiresOn` string, date-time: When the invitation expires (UTC). A cancelled invitation expired when it was cancelled.
    - `createdOn` string, date-time: When the invitation was created (UTC).
    - `invitedByUserId` string, nullable: Unique identifier of the user who sent the invitation.
  - `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

## Other responses

- `400`: When paging is out of range or a `status` value is not one of Pending, Accepted, Expired or Cancelled.
- `403`: When the authenticated client carries no firm account (bodyless).

## Changes

- **2026-10-02** `2f6c7f5744a8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smokeball/apis/smokeball-api/changes/invitations/get.md)

---

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