---
updatedAt: 2026-05-28T19:20:39.000Z
agentTools:
  projectIndex: https://developers.remberg.de/llms.txt
---

# Get a form by ID

Returns the details of a single form instance identified by its ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v1/forms/{id}": {
      "get": {
        "description": "Returns the details of a single form instance identified by its ID.",
        "operationId": "/v1/forms/{id}_get",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The form's ID.",
            "schema": {
              "format": "^[a-f]{24}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Form details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormDetailsCfaResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid required parameter/s"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [
          {
            "authorization": []
          }
        ],
        "summary": "Get a form by ID",
        "tags": [
          "forms"
        ],
        "x-controller-class": "FormsCfaController"
      }
    }
  },
  "info": {
    "title": "Forms",
    "description": "The remberg Forms API description",
    "version": "v1",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.remberg.de"
    }
  ],
  "components": {
    "securitySchemes": {
      "authorization": {
        "type": "apiKey",
        "in": "header",
        "name": "authorization"
      }
    },
    "schemas": {
      "FormDetailsCfaResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Form ID"
          },
          "formTemplateId": {
            "type": "string",
            "description": "Form template ID"
          },
          "counter": {
            "type": "number",
            "description": "Form instance counter. In the UI, this is shown as \"FM-001-000001\", but here, it is returned as a regular number.",
            "example": 1
          },
          "name": {
            "type": "string",
            "description": "Form name"
          },
          "relatedWorkOrderId": {
            "type": "string",
            "description": "The internal ID of the related work order."
          },
          "status": {
            "type": "string",
            "enum": [
              "inProgress",
              "finalized"
            ],
            "description": "Form status"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "When this form was created"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string",
            "description": "When this form was last updated"
          },
          "finalizedAt": {
            "format": "date-time",
            "type": "string",
            "description": "When this form was finalized"
          },
          "data": {
            "type": "object",
            "description": "Contains the form data in key value pairs.\nThe key is always the form field ID and should always be defined.\nThe value format depends on the type of the field.\nIf the value is empty, it will be returned as \"null\".\n",
            "example": {
              "input_1": "Some input value",
              "input_2": null,
              "company_select_1": {
                "organizationName": "Company GmbH",
                "organizationNumber": "1234"
              }
            }
          }
        },
        "required": [
          "id",
          "formTemplateId",
          "counter",
          "name",
          "status",
          "createdAt",
          "updatedAt",
          "data"
        ]
      }
    }
  }
}
```