SMsmokeball
Invitations

Search invitations

Changed on

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

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

Query parameters

Offsetinteger
Limitinteger
Statusstring[]

Pending (when omitted), Accepted, Expired or Cancelled; repeat the parameter for more than one.

Searchstring
Example:jane

Filter by invitations whose email address contains the specified text, ignoring case.

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "id": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "email": "jane.doe@example.com",
      "status": "Pending",
      "expiresOn": "2026-10-01T04:31:00Z",
      "createdOn": "2026-09-24T04:31:00Z",
      "invitedByUserId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"
    }
  ]
}

Changes