API Reference

feedbackFormDefinition.list

post
https://api.ashbyhq.com/feedbackFormDefinition.list

Lists all feedback form definitions.

To find active reusable shared forms, send { "sharedOnly": true }. Forms local to an Interview or activity are excluded, including local forms whose interviewId is null. Set includeArchived: true to also include archived shared forms.

Keep the same filters when following pagination cursors or sync tokens. Incremental sync returns matching forms updated since the previous sync; it does not report forms that have left the filtered results.

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

Requires the hiringProcessMetadataRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

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

≤ 100

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

Whether to include archived feedback form definitions in the results.

boolean

When true, return only reusable shared feedback forms, excluding forms local to an Interview or activity. Defaults to false. Use the default includeArchived:false to find active shared forms.

This feature is in beta and may not be available for all organizations. When true, each form field's visibilityCondition tree is included. Defaults to false on this endpoint to keep responses small.

Response

Updated 5 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago