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

# Get a form

> Retrieves a single form by its ID (frm_ prefix).



## OpenAPI

````yaml /openapi.v2.json get /forms/{id}
openapi: 3.1.1
info:
  title: Heffl API v2 (Beta)
  version: 2.0.0
  description: >-
    Heffl REST API v2 (beta) — resource-oriented endpoints with consistent
    response envelopes. Endpoints, schemas, and behavior may change until GA.
    See Agent workflows and ID prefixes guides for automation.
  contact:
    name: Heffl Support
    url: https://heffl.com/support
    email: support@heffl.com
servers:
  - url: https://api.heffl.com/api/v2
    description: Production API Server
security:
  - ApiKeyAuth: []
paths:
  /forms/{id}:
    get:
      tags:
        - Objects
      summary: Get a form
      description: Retrieves a single form by its ID (frm_ prefix).
      operationId: objects.forms.read
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Form ID (frm_ prefix)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Form'
        '400':
          description: Validation error or bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
components:
  schemas:
    Form:
      type: object
      properties:
        id:
          type: string
          description: Form ID (frm_ prefix)
        title:
          type: string
          description: Form title
        description:
          type:
            - string
            - 'null'
          description: Form description shown to respondents
        entity:
          type:
            - string
            - 'null'
          description: CRM entity this form is associated with (e.g. leads, deals), if any
        submissionCount:
          type: number
          description: Total number of submissions received
        createdById:
          type:
            - string
            - 'null'
          description: ID of the user who created the form (usr_ prefix)
        createdByName:
          type:
            - string
            - 'null'
          description: Name of the user who created the form
        createdAt:
          type: string
          format: date-time
          description: When the form was created
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the form was last updated
      required:
        - id
        - title
        - description
        - entity
        - submissionCount
        - createdById
        - createdByName
        - createdAt
        - updatedAt
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````