---
title: "Get list of all invitations"
method: GET
path: "/v3/invitations"
tags: ["Organization API - Invitation"]
---

# Get list of all invitations

`GET /v3/invitations`

Get list of all invitations you created or sent to you.

## Query parameters

- `offset` integer
- `limit` integer
- `organization` string — Uniquely identify an organization.
- `status` 'pending' | 'accepted' | 'declined'
- `role` 'admin' | 'member'

## Response `200`

All invitations you created or sent to you.

- object
  - `count` integer, required — Number of items in results.
  - `next` string, nullable — URL to request next page of results.
  - `previous` string, nullable — URL to request previous page of results.
  - `results` Invitation[], required
    - `identifier` string — Uniquely identify an invitation.
    - `organization` Organization
      - `identifier` string, required — Uniquely identify an organization.
      - `name` string, required
      - `userRole` 'admin' | 'member', required
      - `avatar` string, nullable, required — URL of the organization's avatar.
      - `resthookSignatureKey` string, nullable, required — Used to sign webhook payloads so you can verify their integrity.
      - `isTrial` boolean, required
      - `validationToolConfig` object, nullable, required — Configuration of the embeddable validation tool.
        - `theme` ThemeConfig
          - `palette` object
            - `mode` 'light' | 'dark'
            - `background` union
              - …
            - `text` object
              - …
            - `divider` string
            - `primary` PaletteColorOptions
              - …
            - `secondary` PaletteColorOptions
              - …
            - `success` PaletteColorOptions
              - …
            - `annotation` PaletteColorOptions
              - …
            - `error` PaletteColorOptions
              - …
            - `info` PaletteColorOptions
              - …
            - `warning` PaletteColorOptions
              - …
          - `typography` object
            - `fontFamily` string
            - `fontSize` union
              - …
            - `fontWeightRegular` string
            - `fontWeightMedium` string
            - `fontWeightBold` string
          - `borderRadius` number
          - `fontUrl` string
        - `hideActions` boolean — Hide the confirm document button and other actions.
        - `hideCollection` boolean — Hide the collection selector.
        - `hideEditPages` boolean — Hide the edit pages button.
        - `hideExport` boolean — Hide the export menu.
        - `hideFilename` boolean — Hide the filename input.
        - `hideShowRawValues` boolean — Hide the toggle for showing raw annotation values.
        - `hideReject` boolean — Hide the reject document button.
        - `hideReparse` boolean — Hide the reparse button.
        - `hideRunOcr` boolean — Hide the run OCR button.
        - `hideTags` boolean — Hide the tags editor.
        - `hideWarnings` boolean — Hide the warnings panel.
        - `restrictDocumentSplitting` boolean — Disable the page editor after a document has been split once.
        - `disableCurrencyFormatting` boolean — Disable currency formatting of decimals values.
        - `disableEditDocumentMetadata` boolean — Disable editing document metadata. Makes the collection selector, filename input and tags editor read only.
        - `disableManualAnnotationEditing` boolean — Disable manual editing of annotation values via the validation popover.
        - `hideDocumentStatus` boolean — Hide the document status indicator in the toolbar.
      - `showCustomFieldCreation` boolean, required — Whether to show the custom field creation in the UI.
      - `allowDataSourceRecordCreation` boolean, required — Allow reviewers to create missing records from the data source selector. Keep disabled when data sources are managed by external system syncs.
    - `email` string — The email which the invitation is sent to.
    - `role` 'admin' | 'member'
    - `status` 'pending' | 'accepted' | 'declined'
    - `expiryDate` string, date — The date after which the invitation expires. Default is 10 days from now.
    - `invitedBy` User
      - `id` integer — Uniquely identify a user.
      - `name` string
      - `username` string
      - `email` string
      - `avatar` string, nullable — URL of the user's avatar.
    - `respondedBy` object, nullable — The person who receives this invitation can register/signin with any account and respond to it. This field stores which account has responded to the invitation.
      - `id` integer — Uniquely identify a user.
      - `name` string
      - `username` string
      - `email` string
      - `avatar` string, nullable — URL of the user's avatar.
    - `createdDt` string, date-time

## Other responses

- `400` — Bad request. If it is a validation error will contain a list of each invalid field
- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)