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

# List all forms



## OpenAPI

````yaml GET /forms
openapi: 3.1.0
info:
  title: Caspen
  version: 0.0.1
servers:
  - url: https://api.caspen.com/v1
    description: Production
security: []
paths:
  /forms:
    get:
      tags:
        - Form
      operationId: form.index
      parameters:
        - name: cursor
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 10
      responses:
        '200':
          description: Paginated set of `FormResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormCollection'
                  links:
                    type: object
                    properties:
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - prev
                      - next
                required:
                  - data
                  - links
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    FormCollection:
      type: array
      items:
        $ref: '#/components/schemas/FormResource'
      title: FormCollection
    FormResource:
      type: object
      properties:
        id:
          type: string
          description: The form's unique identifier.
          examples:
            - for_01HQFQ9QWTNNPY58FZ8CB3FWWK
        client_id:
          type: string
          description: The identifier of the client the form belongs to.
          examples:
            - cli_01HQFQ9QWTNNPY58FZ8CB3FWWK
        location_id:
          type:
            - string
            - 'null'
          description: The identifier of the location the form is associated with.
          examples:
            - loc_01HZR88VXZ3G2NTVPEB2PCCKDY
        form_template_id:
          type: string
          description: The identifier of the form template the form was created from.
          examples:
            - fte_01HYHYQHA682J0K1RW7B2HVA9F
        appointment_client_id:
          type:
            - string
            - 'null'
          description: The identifier of the appointment client the form was created for.
          examples:
            - apc_01HYHYW37MTYJPMT5JV4RN99GK
        name:
          type: string
          description: The form's name.
          examples:
            - Intake questionnaire
        color:
          type: string
          description: The form's display colour.
          examples:
            - blue
        completion_message:
          type: string
          description: The message shown to the client once the form is submitted.
          examples:
            - Thanks for completing your form.
        prefill_client_fields:
          type: boolean
          description: Whether the client's existing details are prefilled into the form.
          examples:
            - true
        override_client_fields:
          type: boolean
          description: >-
            Whether submitting the form overwrites the client's existing
            details.
          examples:
            - false
        status:
          $ref: '#/components/schemas/FormStatus'
          description: The form's completion status.
          examples:
            - completed
        sent_status:
          type:
            - string
            - 'null'
          description: The form's delivery status, or null if it has not been sent.
          examples:
            - viewed
        content:
          type: array
          description: The form's pages, sections, questions and answers.
          items:
            type: object
            properties:
              sections:
                type: array
                items:
                  type: object
                  properties:
                    title:
                      type: string
                    description:
                      type:
                        - string
                        - 'null'
                    questions:
                      type: array
                      items:
                        type: object
                        additionalProperties: {}
                  required:
                    - title
                    - description
                    - questions
        hosted_form_url:
          type: string
          description: The URL the client uses to complete the form.
          examples:
            - https://example.caspen.com/form/for_01HQFQ9QWTNNPY58FZ8CB3FWWK
        sent_at:
          type:
            - string
            - 'null'
          description: The timestamp when the form was sent to the client (ISO 8601).
          examples:
            - '2024-01-01T12:00:00Z'
        viewed_at:
          type:
            - string
            - 'null'
          description: The timestamp when the client first viewed the form (ISO 8601).
          examples:
            - '2024-01-01T13:00:00Z'
        completed_at:
          type:
            - string
            - 'null'
          description: The timestamp when the client completed the form (ISO 8601).
          examples:
            - '2024-01-01T14:00:00Z'
        archived_at:
          type:
            - string
            - 'null'
          description: >-
            The timestamp when the form was archived (ISO 8601), or null if it
            is active.
          examples:
            - '2024-02-01T09:00:00Z'
        created_at:
          type: string
          description: The timestamp when the form was created (ISO 8601).
          examples:
            - '2024-01-01T12:00:00Z'
      title: FormResource
    FormStatus:
      type: string
      enum:
        - not_started
        - in_progress
        - completed
      title: FormStatus
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors

````