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

# Get a form

> One form with its questions.

**Permission:** `modules.forms.forms.read`



## OpenAPI

````yaml /docs/modules-api.yaml get /application/modules/forms/forms/{form}
openapi: 3.1.0
info:
  title: Spartan Module API
  version: '2026.11'
  description: >-
    Endpoints added by modules. Key endpoints live under
    `/api/application/modules/<module>/` and need an API key with the module
    permission. Content modules (Blog, News, Knowledge Base, Status) also offer
    keyless read only endpoints under `/api/public/modules/<module>/` that only
    return what an anonymous visitor can see.
servers:
  - url: https://{domain}/api
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Blog
  - name: Blog (public)
  - name: News
  - name: News (public)
  - name: Knowledge Base
  - name: Knowledge Base (public)
  - name: Status
  - name: Status (public)
  - name: Forms
  - name: Affiliates
  - name: Deprecated endpoints
paths:
  /application/modules/forms/forms/{form}:
    get:
      tags:
        - Forms
      summary: Get a form
      description: |-
        One form with its questions.

        **Permission:** `modules.forms.forms.read`
      operationId: getForm
      parameters:
        - name: form
          in: path
          required: true
          description: Form id.
          schema:
            type: integer
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Form'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  id: 7
                  name: Partner application
                  description: erfgb
                  status: active
                  logo_url: null
                  allow_multiple_submissions: false
                  questions_count: 2
                  submissions_count: 0
                  pending_submissions_count: 0
                  created_at: '2025-12-12T11:14:28Z'
                  updated_at: '2025-12-12T11:14:28Z'
                  questions:
                    - id: 7
                      question: Tell us about your project
                      type: text
                      options: []
                      allow_multiple: false
                      required: false
                      order: 0
                      icon: star
                    - id: 9
                      question: Do you accept the partner terms?
                      type: select
                      options:
                        - 'Yes'
                        - 'Yes'
                      allow_multiple: false
                      required: false
                      order: 1
                      icon: question
                meta:
                  request_id: d8721046-2eb2-4703-a403-39fb8e68e730
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  summary: Unknown form
                  value:
                    error:
                      code: not_found
                      message: Form not found.
                      details: {}
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
components:
  schemas:
    Form:
      type: object
      properties:
        id:
          type: integer
          description: Form id.
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - active
            - inactive
            - draft
        logo_url:
          type:
            - string
            - 'null'
        allow_multiple_submissions:
          type: boolean
        questions_count:
          type: integer
        submissions_count:
          type: integer
        pending_submissions_count:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        questions:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              question:
                type: string
              type:
                type: string
                description: >-
                  Input type, for example `text`, `textarea`, `select`,
                  `checkbox`.
              options:
                type: array
                items:
                  type: string
                description: Choices for select style questions.
              allow_multiple:
                type: boolean
              required:
                type: boolean
              order:
                type: integer
              icon:
                type:
                  - string
                  - 'null'
          description: Single form responses only.
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 6bf04242-ac61-44b9-9dbf-b63a114b54c8
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

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