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

# List your invites

> Your organization's invites, newest first. Needs `invites:read` (or `invites:write`).



## OpenAPI

````yaml /rep-api/openapi.yaml get /invites
openapi: 3.0.3
info:
  title: VitaRelay Rep API
  version: 1.0.0
  description: >-
    The Rep API is for rep organizations (a Vita Rep, or a dual Rep + Clinic
    account) that recruit clinics and other reps. Create the invite you would
    otherwise send from the "Refer a Tele Clinic" form, get the signup link
    back, track whether it was accepted, and revoke it.
servers:
  - url: https://vitarelay.com/api/public/rep/v1
security:
  - bearerAuth: []
tags:
  - name: Invites
    description: Clinic and rep invites sent by your organization.
paths:
  /invites:
    get:
      tags:
        - Invites
      summary: List your invites
      description: >-
        Your organization's invites, newest first. Needs `invites:read` (or
        `invites:write`).
      operationId: listInvites
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - accepted
              - expired
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: cursor
          in: query
          required: false
          description: The `next_cursor` from the previous page.
          schema:
            type: string
      responses:
        '200':
          description: A page of invites.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invite'
                  next_cursor:
                    type: string
                    nullable: true
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
components:
  schemas:
    Invite:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - clinic
            - rep
        status:
          type: string
          enum:
            - pending
            - accepted
            - expired
        invite_code:
          type: string
        invite_url:
          type: string
          description: The signup link, on your own branded domain when you have one.
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        product_types:
          type: array
          nullable: true
          items:
            type: string
        external_invite_id:
          type: string
          nullable: true
          description: Echoed on create and on a retry; not stored on later reads.
        expires_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Forbidden:
      description: >-
        `insufficient_scope` (the key lacks the scope) or `not_available` (your
        organization is not a rep or dual Rep + Clinic account).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationFailed:
      description: >-
        `validation_failed` — a field is missing or invalid; the message says
        which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        VitaRelay API key (`vr_live_...` or `vr_test_...`) with the `invites:*`
        scopes.

````

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