> ## Documentation Index > Fetch the complete documentation index at: https://docs.scanova.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Form > Retrieves details of a specific form. Requires authentication. ## Overview Retrieves detailed information about a specific form, including its configuration, linked QR codes, and submission statistics. ## Path Parameters | Parameter | Type | Required | Description | Example | | --------- | ------ | -------- | ------------------ | ------------------- | | `form_id` | string | Yes | Form ID (form\_id) | `Fecb6be7be43b4724` | ## Response Returns a complete form object with the following additional fields: * **`data`**: JSON string containing the form configuration * **`conversion`**: Conversion rate as a percentage (entries / total scans × 100) ## Form Configuration The `data` field contains a JSON string with the form configuration, including: * **Page Layout** (`page_layout`): Background color and styling * **Design Info** (`design_info`): Button styles, text styles, and color theme * **Form Details** (`form_details`): Page title, description, and form questions * **Submit Button** (`submit_button`): Styling and label for the submit button * **Skip Button** (`skip_button`): Styling and label for the skip button ## Examples ### Retrieve Form Details ```bash theme={null} curl -X GET "https://management.scanova.io/form/Fecb6be7be43b4724/" \ -H "Authorization: YOUR_API_KEY" ``` ### Response Example ```json theme={null} { "id": 301, "form_id": "Fecb6be7be43b4724", "name": "Customer Feedback Form", "created": "2024-03-15T10:30:00.000000+05:30", "modified": "2024-03-15T10:30:00.000000+05:30", "is_active": true, "usage_count": 3, "entries_count": 42, "conversion": 68.5, "linked_qrs": [ { "qr_code__id": 150157, "qr_code__qrid": "Qff07909fe1c14923", "qr_code__name": "Event Booth QR", "qr_code__qr_type": "dy" } ], "data": "[{\"type\":\"page_layout\",\"data\":{\"themeId\":\"ocean-clean\"}},{\"type\":\"design_info\",\"data\":{\"color\":{\"background\":\"#C1E8FA\"},\"button\":{\"color\":\"#2D2B2B\",\"textColor\":\"#FFFFFF\",\"cornerRadius\":2,\"fontFamily\":\"Inter\",\"showDropShadow\":false},\"text\":{\"headerTitle\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"body\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1},\"privacy\":{\"color\":\"#2D2B2B\",\"fontFamily\":\"Inter\",\"fontSize\":1}}}},{\"type\":\"form_details\",\"data\":{\"title\":\"Get in Touch with Us\",\"description\":\"Interested in our services? Fill out the form and we'll get back to you.\",\"questions\":[{\"question\":\"Full Name\",\"answer\":{\"type\":\"shortAnswer\"},\"isRequired\":true}]}},{\"type\":\"submit_button\",\"data\":{\"label\":\"Submit\"}},{\"type\":\"skip_button\",\"data\":{\"label\":\"Skip\"}}]" } ``` ## Use Cases * **Form Configuration**: Get the complete form configuration for editing * **Analytics**: View submission statistics, conversion rate, and linked QR codes * **Integration**: Use form details for third-party integrations The `data` field contains a JSON structure that defines the entire form. Supported component types are: `page_layout`, `design_info`, `form_details`, `submit_button`, and `skip_button`. ## OpenAPI ````yaml GET /form/{form_id}/ openapi: 3.1.0 info: title: Scanova Form API description: Form management endpoints for creating, updating, and managing forms version: 1.0.0 servers: - url: https://management.scanova.io description: Production server security: - apiKeyAuth: [] tags: - name: Form description: Form management operations paths: /form/{form_id}/: get: tags: - Form summary: Retrieve Form description: Retrieves details of a specific form. Requires authentication. parameters: - name: form_id in: path required: true description: Form ID (form_id) schema: type: string example: Fecb6be7be43b4724 responses: '200': description: Form details content: application/json: schema: $ref: '#/components/schemas/Form' examples: form_details: summary: Form details value: id: 301 form_id: Fecb6be7be43b4724 name: Customer Feedback Form created: '2024-03-15T10:30:00.000000+05:30' modified: '2024-03-15T10:30:00.000000+05:30' is_active: true usage_count: 3 entries_count: 42 conversion: 68.5 linked_qrs: - qr_code__id: 150157 qr_code__qrid: Qff07909fe1c14923 qr_code__name: Event Booth QR qr_code__qr_type: dy data: >- [{"type":"page_layout","data":{"themeId":"ocean-clean"}},{"type":"design_info","data":{"color":{"background":"#C1E8FA"},"button":{"color":"#2D2B2B","textColor":"#FFFFFF","cornerRadius":2,"fontFamily":"Inter","showDropShadow":false},"text":{"headerTitle":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"body":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"privacy":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1}}}},{"type":"form_details","data":{"title":"Get in Touch with Us","description":"Interested in our services? Fill out the form and we'll get back to you.","questions":[{"question":"Full Name","answer":{"type":"shortAnswer"},"isRequired":true}]}},{"type":"submit_button","data":{"label":"Submit"}},{"type":"skip_button","data":{"label":"Skip"}}] '401': description: Unauthorized - Invalid API key content: application/json: schema: $ref: '#/components/schemas/AuthenticationErrorResponse' '404': description: Form not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: schemas: Form: type: object properties: id: type: integer description: Internal form ID example: 301 form_id: type: string description: Unique form identifier example: Fecb6be7be43b4724 name: type: string description: Name of the form example: Customer Feedback Form created: type: string format: date-time description: Creation timestamp example: '2024-03-15T10:30:00.000000+05:30' modified: type: string format: date-time description: Last modification timestamp example: '2024-03-15T10:30:00.000000+05:30' is_active: type: boolean description: Whether the form is active example: true usage_count: type: integer description: Number of QR codes this form is linked to example: 3 entries_count: type: integer description: Number of form submissions collected example: 42 conversion: type: number format: float description: Conversion rate as a percentage (entries / total scans * 100) example: 68.5 linked_qrs: type: array description: QR codes linked to this form items: type: object properties: qr_code__id: type: integer example: 150157 qr_code__qrid: type: string example: Qff07909fe1c14923 qr_code__name: type: string example: Event Booth QR qr_code__qr_type: type: string example: dy data: type: string description: JSON string containing the form configuration example: >- [{"type":"page_layout","data":{"themeId":"ocean-clean"}},{"type":"design_info","data":{"color":{"background":"#C1E8FA"},"button":{"color":"#2D2B2B","textColor":"#FFFFFF","cornerRadius":2,"fontFamily":"Inter","showDropShadow":false},"text":{"headerTitle":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"body":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1},"privacy":{"color":"#2D2B2B","fontFamily":"Inter","fontSize":1}}}},{"type":"form_details","data":{"title":"Get in Touch with Us","description":"Interested in our services? Fill out the form and we'll get back to you.","questions":[{"question":"Full Name","answer":{"type":"shortAnswer"},"isRequired":true}]}},{"type":"submit_button","data":{"label":"Submit"}},{"type":"skip_button","data":{"label":"Skip"}}] AuthenticationErrorResponse: type: object properties: detail: type: string description: Authentication error message example: Invalid token. ErrorResponse: type: object properties: detail: type: string description: Error message example: Not found. securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Enter your API key directly in the Authorization header. ````