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

# list meeting invites

> List meeting invites for the authenticated organization, most recent
first. Filter by `status` to find invites in a particular lifecycle
state — for example `pending` invites that have not joined yet, or
`active` invites currently in a call.




## OpenAPI

````yaml https://api.anam.ai/swagger.json get /v1/meetings/invites
openapi: 3.1.0
info:
  title: Anam AI API
  version: '1.0'
servers:
  - url: https://api.anam.ai
    description: Anam API
security:
  - BearerAuth: []
tags:
  - name: Sessions
  - name: Meetings
  - name: Personas
  - name: Avatars
  - name: Voices
  - name: LLMs
  - name: Knowledge
  - name: Tools
  - name: Share Links
  - name: Engine
paths:
  /v1/meetings/invites:
    get:
      tags:
        - Meetings
      summary: List meeting invites
      description: |
        List meeting invites for the authenticated organization, most recent
        first. Filter by `status` to find invites in a particular lifecycle
        state — for example `pending` invites that have not joined yet, or
        `active` invites currently in a call.
      operationId: listMeetingInvites
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - in: query
          name: perPage
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          description: Number of items per page (max 100)
        - in: query
          name: status
          schema:
            type: string
            enum:
              - pending
              - active
              - cancelled
              - ended
              - failed
          description: Filter invites by status
      responses:
        '200':
          description: Successfully retrieved meeting invites
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MeetingInvite'
                  meta:
                    $ref: '#/components/schemas/Pagination'
        '400':
          description: Bad request - invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingInviteValidationError'
        '401':
          description: Unauthorized - missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingInviteError'
              examples:
                missingKey:
                  value:
                    error: Missing or invalid API key
                invalidKey:
                  value:
                    error: Invalid API key
        '403':
          description: Forbidden - API key lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingInviteError'
              examples:
                forbidden:
                  value:
                    error: Forbidden
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingInviteError'
              examples:
                serverError:
                  value:
                    error: Failed to process meeting invite
components:
  schemas:
    MeetingInvite:
      type: object
      description: A meeting invite created for a persona.
      required:
        - id
        - provider
        - meetingUrl
        - displayName
        - status
        - createdAt
        - joinAt
        - groupCall
        - sessionId
        - region
        - joinState
        - statusReason
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the meeting invite.
        provider:
          type: string
          enum:
            - google_meet
            - zoom
            - microsoft_teams
          description: Meeting provider inferred from the meeting URL.
        meetingUrl:
          type: string
          format: uri
          description: Normalized meeting URL.
        displayName:
          type: string
          description: Display name used in the meeting.
        status:
          type: string
          enum:
            - pending
            - active
            - cancelled
            - ended
            - failed
          description: Current invite status.
        createdAt:
          type: string
          format: date-time
          description: Time the invite was created.
        joinAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Scheduled time the persona joins the meeting, or null when the
            persona was asked to join immediately.
        groupCall:
          type: boolean
          description: >-
            Whether group-call turn-taking is enabled for this invite (respond
            only when addressed by name; silent join).
        sessionId:
          type:
            - string
            - 'null'
          description: >-
            Engine session ID once the meeting session has started, otherwise
            null.
        region:
          type:
            - string
            - 'null'
          enum:
            - eu
            - us-east
            - us-west
            - null
          description: >-
            Region the persona joined the call from. May differ from the
            requested region when the invite was served by another region for
            availability. Additional region values may be introduced over time;
            treat unrecognized values as informational rather than an error.
        joinState:
          type:
            - string
            - 'null'
          enum:
            - joining
            - waiting_room
            - in_call
            - media_denied
            - media_granted
            - media_active
            - left
            - done
            - error
            - null
          description: >-
            Latest observed call-participation detail for the persona, updated
            asynchronously as the persona connects, waits for admission, joins,
            and leaves. Null until the first update arrives. Values may be added
            over time; treat unrecognized values as informational.
        statusReason:
          type:
            - string
            - 'null'
          description: >-
            Reason attached to a terminal participation state — for example
            `removed_by_host`, `meeting_ended`, `not_admitted`, `join_denied`,
            `meeting_link_invalid`, `meeting_not_started`, `idle_timeout`,
            `left_call`, or `provider_error`. Null while the invite is in
            progress. Values may be added over time; treat unrecognized values
            as informational.
    Pagination:
      type: object
      description: >-
        Pagination metadata returned alongside the `data` array of every list
        endpoint.
      properties:
        total:
          type: integer
          description: Total number of items across all pages.
        lastPage:
          type: integer
          description: Number of the last page.
        currentPage:
          type: integer
          description: Number of the current page.
        perPage:
          type: integer
          description: Number of items per page.
        prev:
          type:
            - integer
            - 'null'
          description: Number of the previous page, or null if on the first page.
        next:
          type:
            - integer
            - 'null'
          description: Number of the next page, or null if on the last page.
    MeetingInviteValidationError:
      type: object
      required:
        - error
        - details
        - summary
      properties:
        error:
          type: string
          example: Validation error
        details:
          type: array
          items:
            type: object
            required:
              - path
              - message
              - code
            properties:
              path:
                type: string
                example: personaId
              message:
                type: string
                example: Provide exactly one of personaId or personaConfig
              code:
                type: string
                example: custom
        summary:
          type: string
          example: 'personaId: Provide exactly one of personaId or personaConfig'
    MeetingInviteError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````