> ## Documentation Index
> Fetch the complete documentation index at: https://docs.versori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Invitations

> GetInvitations returns a paginated list of invitations for the given Organisation.



## OpenAPI

````yaml /openapi/organisations-api-v1.yaml get /organisations/{organisation_id}/invitations
openapi: 3.1.0
info:
  title: Organisations API
  description: >-
    The Organisations API provides users the ability to manage their
    organisations.
  version: v1
servers:
  - url: https://platform.versori.com/api/organisations/v1
    description: Production server
  - url: http://localhost:8081/v1
    description: Localhost
security: []
tags:
  - name: organisations
    description: >
      Organisations is the root-level entity for the Versori platform. All
      resources are scoped under an Organisation,

      each Organisation has an owner and can have multiple members.
  - name: signing-keys
    description: >
      Signing keys are used to sign JWTs which can be used to authenticate
      requests to the Versori platform.
paths:
  /organisations/{organisation_id}/invitations:
    parameters:
      - $ref: '#/components/parameters/organisation_id'
    get:
      summary: Get Invitations
      description: >-
        GetInvitations returns a paginated list of invitations for the given
        Organisation.
      operationId: GetInvitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvitationsPage'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    organisation_id:
      name: organisation_id
      in: path
      x-go-name: OrganisationID
      required: true
      schema:
        type: string
  schemas:
    InvitationsPage:
      type: object
      allOf:
        - $ref: '#/components/schemas/PageInfo'
        - type: object
          properties:
            invitations:
              type: array
              items:
                $ref: '#/components/schemas/Invitation'
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        cause:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message
    PageInfo:
      type: object
      properties:
        totalCount:
          type: integer
        next:
          type: string
          x-go-type-skip-optional-pointer: true
        prev:
          type: string
          x-go-type-skip-optional-pointer: true
    Invitation:
      description: >-
        Invitation represents an invitation to join an Organisation. The
        invitation may be deleted if it is no longer wanted, or a new invitation
        email can be sent. Accepted invitations are automatically deleted.
      type: object
      properties:
        id:
          type: string
          format: ulid
          x-go-name: ID
          x-go-type: ulid.ULID
          x-go-type-import:
            path: versori.dev/vergo/ulid
        email:
          type: string
          format: email
        name:
          type: string
        picture:
          type: string
          format: url
        accepted:
          type: boolean
        inviteType:
          type: string
          enum:
            - transfer_ownership
            - join_organisation
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        roles:
          description: >-
            Roles are the list of role names to be granted to this Member at the
            organisation scope.
          type: array
          items:
            type: string
        groupIDs:
          description: GroupIDs are the list of group IDs to be added to this Member.
          type: array
          items:
            type: string
      required:
        - id
        - inviteType
        - name
        - picture
        - email
        - accepted

````