Sign in

v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
invitations

List invitations to a portal

Lists invitations to the matching portal.

Important: You can get the portal ID in the response from Fetch an organization.

get/portals/{portal_id}/invitations

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 a comma-separated list (no spaces) of any of the following record names to return those records related to the invitations you're fetching. Related records are returned in an included array in the response.

Allowed values:

  • inviter
  • inviteable

WARNING: This parameter can slow response times.

Response

Invitations to the matching portal.

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"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}