Sign in

v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
invitations

Fetch an invitation

Gets a matching invitation.

get/invitations/{invitation_id}

Query parameters

fieldsstring

Set it to created_at to return it as part of the invitation's attributes in the response.

Allowed value: created_at

WARNING: This parameter can slow response times.

includestring

Set it to inviteable to include the Brandfolder, Collection, or Organization that this Invitation is for.

Allowed value: inviteable

WARNING: This parameter can slow response times.

Headers

Accept'application/json' required

Response

The matching invitation.

Example response

{
  "data": {
    "id": "a3dlao-hd6so4-7d91d2",
    "attributes": {
      "email": "test@example.com",
      "permission_level": "guest",
      "personal_message": "Welcome to my Brandfolder!",
      "invitation_url": "https://brandfolder.com/invitations/abc123"
    }
  }
}