# 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.

Endpoint: GET /portals/{portal_id}/invitations
Version: v4
Security: APIToken

## Path parameters:

  - `portal_id` (string, required)
    Unique identifier for the resource instance.
    Example: "oqgiju-21olts-ce9egi"

## Header parameters:

  - `Content-Type` (string, required)
    Enum: "application/json"

  - `Authorization` (string, required)
    Bearer token for authentication

## Query parameters:

  - `fields` (string)
    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.
    Example: "created_at"

  - `include` (string)
    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.
    Example: "inviter"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)
    Unique identifier for the resource instance.
    Example: "a3dlao-hd6so4-7d91d2"

  - `data.type` (string, required)
    The type of the resource.
    Enum: "invitations"

  - `data.attributes` (object, required)

  - `data.attributes.email` (string, required)
    Email address of the recipient.
    Example: "test@example.com"

  - `data.attributes.permission_level` (string)
    Access to grant the recipient.
    Example: "guest"

  - `data.attributes.personal_message` (string)
    A message for the recipient.
    Example: "Welcome to my Brandfolder!"

  - `data.attributes.invitation_url` (string)
    The invitation's URL.
    Example: "https://brandfolder.com/invitations/abc123"

  - `meta` (object, required)
    Page context information.

  - `meta.current_page` (integer, required)
    Example: 1

  - `meta.next_page` (object,null, required)

  - `meta.prev_page` (object,null, required)

  - `meta.total_pages` (number, required)
    Example: 1

  - `meta.total_count` (number, required)
    Example: 1