SMsmokeball
Invitations

Get an invitation

Changed on

A newly created invitation answers 404 for a few seconds after POST /invitations returns.

get/invitations/{id}

Request

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

Path parameters

idstring required

Unique identifier of the invitation.

Response

When the request is successful. Returns an 'Invitation' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the invitation.

emailstring nullable

Email address the invitation was sent to.

statusstring

Pending, Accepted (the person registered with the firm), Expired or Cancelled.

expiresOnstring date-time

When the invitation expires (UTC). A cancelled invitation expired when it was cancelled.

createdOnstring date-time

When the invitation was created (UTC).

invitedByUserIdstring nullable

Unique identifier of the user who sent the invitation.

Example response

{
  "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