Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
FeedbackFormDefinition

feedbackFormDefinition.list

Lists all feedback form definitions.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the hiringProcessMetadataRead permission.

post/feedbackFormDefinition.list

Request body

syncTokenstring nullable

A sync token to retrieve only feedback form definitions updated since the last sync. Obtained from a previous list response.

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitinteger nullable

The maximum number of feedback form definitions to return per page. Maximum is 100.

includeArchivedboolean nullable

Whether to include archived feedback form definitions in the results.

Example request

{
  "syncToken": "jYnEBmjzR",
  "cursor": "G8",
  "limit": 25
}

Response

Responses from the feedbackFormDefinition.list 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
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}