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

# Search invitations

> Lists the firm's invitations, most recently expiring first. Only pending invitations are
returned unless `status` says otherwise.



## OpenAPI

````yaml /openapi.json get /invitations
openapi: 3.0.1
info:
  title: API
  version: '1.0'
servers:
  - url: https://api.smokeball.com
  - url: https://api.smokeball.com.au
  - url: https://api.smokeball.co.uk
  - url: https://stagingapi.smokeball.com
  - url: https://stagingapi.smokeball.com.au
  - url: https://stagingapi.smokeball.co.uk
security:
  - api-key: []
    token: []
paths:
  /invitations:
    get:
      tags:
        - Invitations
      summary: Search invitations
      description: "Lists the firm's invitations, most recently expiring first. Only pending invitations are\r\nreturned unless `status` says otherwise."
      operationId: GetInvitations
      parameters:
        - name: Offset
          in: query
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
        - name: Limit
          in: query
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
        - name: Status
          in: query
          description: >-
            Pending (when omitted), Accepted, Expired or Cancelled; repeat the
            parameter for more than one.
          schema:
            type: array
            items:
              type: string
        - name: Search
          in: query
          description: >-
            Filter by invitations whose email address contains the specified
            text, ignoring case.
          schema:
            type: string
            example: jane
          example: jane
      responses:
        '200':
          description: >-
            When the request is successful. Returns a paged collection of
            'Invitation' objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationPagedCollection'
        '400':
          description: >-
            When paging is out of range or a `status` value is not one of
            Pending, Accepted, Expired or Cancelled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: When the authenticated client carries no firm account (bodyless).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    InvitationPagedCollection:
      type: object
      properties:
        id:
          type: string
          nullable: true
        href:
          type: string
          nullable: true
        relation:
          type: string
          nullable: true
        method:
          type: string
          default: GET
          nullable: true
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        value:
          type: array
          items:
            $ref: '#/components/schemas/Invitation'
          nullable: true
        offset:
          type: integer
          format: int32
          nullable: true
        limit:
          type: integer
          format: int32
          nullable: true
        size:
          type: integer
          format: int64
        first:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        previous:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        next:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        last:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
      additionalProperties: false
      description: A page of invitations.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    Link:
      type: object
      properties:
        id:
          type: string
          nullable: true
        href:
          type: string
          nullable: true
        relation:
          type: string
          nullable: true
        method:
          type: string
          default: GET
          nullable: true
      additionalProperties: false
    Invitation:
      type: object
      properties:
        href:
          type: string
          nullable: true
        relation:
          type: string
          nullable: true
        method:
          type: string
          default: GET
          nullable: true
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
          nullable: true
        id:
          type: string
          description: Unique identifier of the invitation.
          nullable: true
          example: 750eb5c5-ac0b-7d11-4997-e0ce9d8896c8
        email:
          type: string
          description: Email address the invitation was sent to.
          nullable: true
          example: jane.doe@example.com
        status:
          type: string
          description: >-
            Pending, Accepted (the person registered with the firm), Expired or
            Cancelled.
          example: Pending
        expiresOn:
          type: string
          description: >-
            When the invitation expires (UTC). A cancelled invitation expired
            when it was cancelled.
          format: date-time
          example: '2026-10-01T04:31:00Z'
        createdOn:
          type: string
          description: When the invitation was created (UTC).
          format: date-time
          example: '2026-09-24T04:31:00Z'
        invitedByUserId:
          type: string
          description: Unique identifier of the user who sent the invitation.
          nullable: true
          example: b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2
      additionalProperties: false
      description: An invitation for a person to join a firm.
  securitySchemes:
    api-key:
      type: apiKey
      name: x-api-key
      in: header
    token:
      type: apiKey
      name: Authorization
      in: header
      x-amazon-apigateway-authtype: cognito_user_pools

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.