GET
/
api
/
form-response
/
{id}
curl --request GET \
  --url https://app.flashquotes.com/api/form-response/{id} \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "clh2x4j9s0000qw3v5km8j1t2",
    "createdAt": "2024-01-15T08:30:00Z",
    "updatedAt": "2024-01-15T08:30:00Z",
    "formId": "clh2x4j9s0001qw3v5km8j1t3",
    "bookingId": null,
    "quoteId": "clh2x4j9s0002qw3v5km8j1t4",
    "companyId": "clh2x4j9s0003qw3v5km8j1t5",
    "formQuestionResponses": [
      {
        "id": "clh2x4j9s0004qw3v5km8j1t6",
        "response": "John Doe",
        "createdAt": "2024-01-15T08:30:00Z",
        "updatedAt": "2024-01-15T08:30:00Z",
        "question": {
          "id": "clh2x4j9s0005qw3v5km8j1t7",
          "title": "What is your full name?",
          "type": "TEXT",
          "subtitle": "Please enter your first and last name",
          "position": 1,
          "systemRequired": true,
          "userRequired": true,
          "linkedSystemField": "clientName"
        }
      }
    ]
  }
]

This endpoint returns comprehensive information about a specific form response, including all question responses and their associated questions.

​
Response

The response includes a detailed form response object containing:

  • Form response identification and metadata
  • Form and booking associations
  • Question responses with:
    • Question details (title, type, requirements)
    • User’s response data
    • Question metadata (position, system links)
  • Timestamps for creation and updates

​
Common Use Cases

  • Retrieving submission details for display
  • Accessing customer responses
  • Verifying form completion status
  • Integrating with external systems
  • Analyzing response data

​
Notes

  • The form response ID must be valid and associated with your company
  • Returns a 404 error if the form response is not found
  • All timestamps are returned in ISO 8601 format
  • Access requires a valid API key with appropriate permissions
  • Response data format varies based on question type

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

ID of form response to retrieve

Response

200
application/json
Form response data
​
id
string

The unique identifier of the form response

​
createdAt
string

When the form response was created

​
updatedAt
string

When the form response was last updated

​
formId
string

ID of the form this response belongs to

​
bookingId
string | null

ID of the booking if this form response is associated with a booking

​
quoteId
string

ID of the quote this form response is associated with

​
companyId
string

ID of the company this form response belongs to

​
formQuestionResponses
object[]

Was this page helpful?

List EventsList Invoices