List Invitations - SnackBase

GET

api

invitations

List Invitations

curl --request GET \
  --url https://api.example.com/api/v1/invitations

{
  "invitations": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "account_code": "<string>",
      "email": "<string>",
      "invited_by": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "token": "<string>",
      "accepted_at": "2023-11-07T05:31:56Z",
      "email_sent": false,
      "email_sent_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Query Parameters

status_filter

enum<string> | null

Invitation status enum.

Available options:

pending,

accepted,

expired,

cancelled

account_id

string | null

Response

Successful Response

Response schema for listing invitations.

invitations

InvitationResponse · object[]

required

List of invitations

Show child attributes

total

integer

required

Total number of invitations

Create InvitationCreate a new invitation. Creates an invitation for a user to join the current user's account. Sends an invitation email with a secure token. Flow: 1. Validate email format (handled by Pydantic) 2. Check if user already exists in account 3. Check if pending invitation exists 4. Generate secure token 5. Create invitation record 6. Send invitation email 7. Return invitation details (excluding token)

List Invitations

curl --request GET \
  --url https://api.example.com/api/v1/invitations

{
  "invitations": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "account_code": "<string>",
      "email": "<string>",
      "invited_by": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "token": "<string>",
      "accepted_at": "2023-11-07T05:31:56Z",
      "email_sent": false,
      "email_sent_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}