Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application Feedback

applicationFeedback.list

List all interview scorecards and feedback submissions associated with an application.

Each feedback submission contains:

  • formDefinition: The structure of the feedback form with all available fields
  • submittedValues: Responses to the form fields, which depending on the form configuration can include:
    • Text feedback (e.g., "Candidate showed strong technical skills...")
    • Numerical scores (e.g., "4" for a 1-4 rating scale)
    • Structured selections, returned as the stored option value rather than its display label (e.g., "hire", not "Hire"); use the field's selectableValues in formDefinition to map values to labels
  • Interview context: Links to associated interviews, events, and the submitting user

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

Requires the candidatesRead permission.

post/applicationFeedback.list

Request body

applicationIdstring uuid nullable

The id of the application you'd like to fetch feedback for

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 items to return per page. The maximum and default value is 100.

syncTokenstring nullable

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

createdAfternumber nullable

Unix timestamp (milliseconds). When provided, only feedback created at or after this time is returned.

Example request

{
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR",
  "createdAfter": 1659979196538
}

Response

Responses from the applicationFeedback.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "applicationId": "550e8400-e29b-41d4-a716-446655440000",
      "feedbackFormDefinitionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "interviewId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "interviewEventId": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
      "submittedAt": "2023-11-15T14:30:00.000Z",
      "submittedByUser": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "Sarah",
        "lastName": "Johnson",
        "email": "sarah.johnson@company.com",
        "globalRole": "Elevated Access",
        "isEnabled": true,
        "updatedAt": "2023-11-15T14:30:00.000Z"
      },
      "creditedToUser": {
        "id": "3f60c5d3-37bd-44fd-b941-97082c04a496",
        "firstName": "Michael",
        "lastName": "Bluth",
        "email": "michael.bluth@company.com",
        "globalRole": "Limited Access",
        "isEnabled": true,
        "updatedAt": "2023-11-15T14:30:00.000Z"
      },
      "formDefinition": {
        "sections": [
          {
            "title": "Technical Assessment",
            "fields": [
              {
                "isRequired": true,
                "field": {
                  "id": "550e8400-e29b-41d4-a716-446655440001",
                  "type": "ValueSelect",
                  "path": "overall_recommendation",
                  "title": "Overall Recommendation",
                  "humanReadablePath": "Overall Recommendation",
                  "isNullable": false,
                  "selectableValues": [
                    {
                      "label": "Strong Hire",
                      "value": "strong_hire"
                    },
                    {
                      "label": "Hire",
                      "value": "hire"
                    },
                    {
                      "label": "No Hire",
                      "value": "no_hire"
                    }
                  ]
                }
              }
            ]
          }
        ]
      },
      "submittedValues": {
        "overall_recommendation": "hire"
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}