> ## Documentation Index
> Fetch the complete documentation index at: https://openphone-dev.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List invitations

> Retrieve a paginated list of workspace invitations. Returns `pending` invitations by default — pass `status=all` to include accepted and cancelled ones.



## OpenAPI

````yaml https://openphone-public-api-dev.s3.us-west-2.amazonaws.com/public/openphone-public-api-2026-03-30-dev.json get /invites
openapi: 3.1.0
info:
  title: Quo Public API
  version: 1.0.0
  description: API for connecting with Quo.
  contact:
    name: Quo Support
    email: support@quo.com
    url: https://support.quo.com/
  termsOfService: https://www.quo.com/terms
servers:
  - description: Development server
    url: https://dev-public-api.openphone.dev
security:
  - apiKey: []
tags:
  - description: Operations related to calls
    name: Calls
  - description: >-
      Operations related to call summaries, including AI-generated summaries and
      Sona voice assistant summaries
    name: Call Summaries
  - description: >-
      Operations related to call transcripts, including AI-generated transcripts
      and Sona voice assistant transcripts
    name: Call Transcripts
  - description: Operations related to contacts
    name: Contacts
  - description: Operations related to contact shares
    name: Contact Shares
  - description: Operations related to contact notes
    name: Contact Notes
  - description: Operations related to contact properties
    name: Contact Properties
  - description: Operations related to conversations
    name: Conversations
  - description: Operations related to workspace invitations
    name: Invites
  - description: Operations related to text messages
    name: Messages
  - description: Operations related to phone numbers
    name: Phone Numbers
  - description: Operations related to users
    name: Users
  - description: Operations related to webhooks
    name: Webhooks
  - description: >-
      Operations related to webhook events, including delivery history and test
      events
    name: Webhook Events
paths:
  /invites:
    get:
      tags:
        - Invites
      summary: List invitations
      description: >-
        Retrieve a paginated list of workspace invitations. Returns `pending`
        invitations by default — pass `status=all` to include accepted and
        cancelled ones.
      operationId: listInvites
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            description: Max number of items to return per page.
            default: 10
            maximum: 50
            minimum: 1
            type: integer
        - in: query
          name: after
          required: false
          schema:
            examples:
              - eyJsYXN0SWQiOiJVU211a09NaXBhIn0
            type: string
          example: eyJsYXN0SWQiOiJVU211a09NaXBhIn0
        - in: query
          name: status
          required: false
          schema:
            type: string
            enum:
              - pending
              - accepted
              - cancelled
              - all
            description: >-
              Filter by invitation state. Defaults to `pending` — pass `all` to
              include accepted and cancelled invitations.
            default: pending
            examples:
              - pending
          example: pending
        - in: header
          name: Quo-Api-Version
          required: true
          schema:
            type: string
            enum:
              - '2026-03-30'
            description: 'API version header. Supported values: 2026-03-30'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - phoneNumberId
                        - email
                        - phoneNumberIds
                        - role
                        - status
                        - acceptedAt
                        - acceptedBy
                        - cancelledAt
                        - createdAt
                        - invitedBy
                        - updatedAt
                      properties:
                        id:
                          description: >-
                            The unique identifier of the invitation. This is an
                            invitation ID, not a user ID — once the invitation
                            is accepted it no longer exists and the person is
                            addressable by their `US…` user ID instead.
                          examples:
                            - IV123abc
                          pattern: ^IV(.*)$
                          type: string
                          example: IV123abc
                        phoneNumberId:
                          description: >-
                            The phone number the invited person will be assigned
                            to, or null when none is assigned.
                          examples:
                            - PN123abc
                          example: PN123abc
                          anyOf:
                            - pattern: ^PN(.*)$
                              type: string
                            - type: 'null'
                        email:
                          description: The email address the invitation was sent to.
                          examples:
                            - johndoe@example.com
                          format: email
                          type: string
                          example: johndoe@example.com
                        phoneNumberIds:
                          type: array
                          items:
                            pattern: ^PN(.*)$
                            type: string
                        role:
                          type: string
                          enum:
                            - owner
                            - admin
                            - member
                          description: >-
                            The role the invited person will hold once they
                            accept.
                          examples:
                            - member
                          example: member
                        status:
                          type: string
                          enum:
                            - pending
                            - accepted
                            - cancelled
                          description: >-
                            The current state of the invitation. Only `pending`
                            invitations can be modified, revoked, or re-sent.
                          examples:
                            - pending
                          example: pending
                        acceptedAt:
                          anyOf:
                            - description: >-
                                Timestamp the invitation was accepted, in ISO
                                8601 format, or null if it has not been
                                accepted.
                              examples:
                                - '2022-01-01T00:00:00Z'
                              format: date-time
                              type: string
                              example: '2022-01-01T00:00:00Z'
                            - type: 'null'
                        acceptedBy:
                          anyOf:
                            - description: >-
                                The user created when the invitation was
                                accepted, or null while it is still pending.
                              examples:
                                - US456def
                              pattern: ^US(.*)$
                              type: string
                              example: US456def
                            - type: 'null'
                        cancelledAt:
                          anyOf:
                            - description: >-
                                Timestamp the invitation was cancelled, in ISO
                                8601 format, or null if it has not been
                                cancelled.
                              examples:
                                - '2022-01-01T00:00:00Z'
                              format: date-time
                              type: string
                              example: '2022-01-01T00:00:00Z'
                            - type: 'null'
                        createdAt:
                          description: >-
                            Timestamp the invitation was created, in ISO 8601
                            format.
                          examples:
                            - '2022-01-01T00:00:00Z'
                          format: date-time
                          type: string
                          example: '2022-01-01T00:00:00Z'
                        invitedBy:
                          anyOf:
                            - description: The user who sent the invitation.
                              examples:
                                - US123abc
                              pattern: ^US(.*)$
                              type: string
                              example: US123abc
                            - type: 'null'
                        updatedAt:
                          description: >-
                            Timestamp of the last update to the invitation, in
                            ISO 8601 format.
                          examples:
                            - '2022-01-01T00:00:00Z'
                          format: date-time
                          type: string
                          example: '2022-01-01T00:00:00Z'
                  nextCursor:
                    description: >-
                      Cursor for the next page, or null when there are no more
                      pages.
                    examples:
                      - eyJsYXN0SWQiOiJVU211a09NaXBhIn0
                    example: eyJsYXN0SWQiOiJVU211a09NaXBhIn0
                    anyOf:
                      - type: string
                      - type: 'null'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    const: https://quo.com/docs
                    type: string
                  title:
                    const: Bad Request
                    type: string
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: The input was invalid
                docs: https://quo.com/docs
                title: Bad Request
                errors:
                  - path: /inviteId
                    message: Expected string to match '^IV(.*)$'
                    value: abc123
                    schema:
                      type: TemplateLiteral
                      pattern: ^IV(.*)$
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    const: https://quo.com/docs
                    type: string
                  title:
                    const: Unauthorized
                    type: string
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: Unauthorized
                docs: https://quo.com/docs
                title: Unauthorized
                trace: '6897907457496870895'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    const: https://quo.com/docs
                    type: string
                  title:
                    const: Forbidden
                    type: string
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: You do not have permission to invite an admin
                docs: https://quo.com/docs
                title: Forbidden
                trace: '6897907457496870895'
        '500':
          description: Unknown Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    const: https://quo.com/docs
                    type: string
                  title:
                    const: Unknown
                    type: string
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: We have encountered an unknown error
                docs: https://quo.com/docs
                title: Unknown
                trace: '6897907457496870895'
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      in: header
      name: Authorization
      type: apiKey

````