Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Feedback Form Definition

feedbackFormDefinition.info

Returns a single feedback form by id

Requires the hiringProcessMetadataRead permission.

post/feedbackFormDefinition.info

Request body

feedbackFormDefinitionIdstring uuid required

The unique id of the feedback form you'd like to fetch.

Example request

{
  "feedbackFormDefinitionId": "9b17887e-5add-49e8-9a03-ffffa669aa2f"
}

Response

Responses from the feedbackFormDefinition.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "c56d8409-8846-44a7-b09e-8959154bcf17",
    "organizationId": "ec647f56-f27a-49a1-84af-021ad0a19f21",
    "title": "Default Feedback Form",
    "isArchived": false,
    "isDefaultForm": true,
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": true,
              "field": {
                "id": "dbf36925-0161-4f40-8a04-fcb49e5bbdb0",
                "type": "ValueSelect",
                "path": "overall_recommendation",
                "humanReadablePath": "Overall Recommendation",
                "title": "Overall Recommendation",
                "isNullable": false,
                "selectableValues": [
                  {
                    "label": "4 - Strong Yes",
                    "value": "4"
                  },
                  {
                    "label": "3 - Yes",
                    "value": "3"
                  }
                ]
              }
            }
          ]
        }
      ]
    },
    "interviewId": null
  }
}