Get Invitation - SnackBase

GET

api

invitations

{token}

Get Invitation

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

{
  "email": "[email protected]",
  "account_name": "<string>",
  "invited_by_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "is_valid": true
}

Path Parameters

token

string

required

Response

Successful Response

Response schema for public invitation details.

string<email>

required

Email address of the invited user

account_name

string

required

Name of the inviting account

invited_by_name

string

required

Name of the person who invited

expires_at

string<date-time>

required

Expiration timestamp

is_valid

boolean

default:true

Whether the invitation is valid

Accept InvitationAccept an invitation and create a user account. Validates the invitation token, creates a user account with the provided password, and returns authentication tokens. Flow: 1. Validate token exists 2. Validate token not expired 3. Validate token not already accepted 4. Validate password strength 5. Create user account 6. Mark invitation as accepted 7. Generate JWT tokens 8. Return auth response

Get Invitation

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

{
  "email": "[email protected]",
  "account_name": "<string>",
  "invited_by_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "is_valid": true
}