api-001 [PR3 Release Note]

This is an old revision of the document!

API: Check Form Field

Method: POST Endpoint: `https://api.qc.cxgenie.ai/api/v1/form-results-value/metadata`

Endpoint Description This endpoint allows you to retrieve metadata related to specific form results within a designated workspace. It is particularly useful for understanding the structure and requirements of forms that are being utilized in your application.

Request URL `https://api.qc.cxgenie.ai/api/v1/form-results-value/metadata`

Request Parameters The request body must be sent in JSON format and should include:

Parameter	Type	Description	Required
workspace_id	string	The unique identifier for the workspace where the form is located.	Yes
form_id	string	The unique identifier for the form whose metadata is being requested.	Yes
workspace_token	string	Authentication token required to access the workspace.	Yes

Response Structure Upon a successful request, the API will return a JSON response:

{
  "success": true,
  "data": {
    "form_name": "Customer Feedback",
    "fields": [
      {
        "field_key": "email",
        "label": "Email",
        "type": "text",
        "required": true
      },
      {
        "field_key": "rating",
        "label": "Rating",
        "type": "number",
        "required": false
      }
    ]
  }
}