Updates - Scorecards & Application Filtering

This update introduces new endpoints for retrieving scorecards and refines how applications are filtered and returned by replacing deprecated fields (state, currentStage) with more precise alternatives (hiringState, stageType, pipelineStage).

New Endpoints

  • List Application Scorecards (GET /v2/applications/{applicationId}/scorecards): We have introduced a new endpoint to retrieve all completed scorecard evaluations for a specific application.
    • Behavior: Returns an unpaginated list of all scorecards for the application in a single response. Returns a 200 OK with an empty array if no scorecards exist.
    • Data Available: Highlights include evaluator details (submittedBy), overall recommendations (overallRecommendation, overallImpression), structured evaluations (attributes), and custom answers (questions).

Deprecations & Migrations

  • Application state: The state query parameter and response field (specifically the SCREENING and QUALIFIED values) are deprecated and will be permanently removed on 2026-11-01.
  • Application currentStage: The currentStage response object is deprecated and will be permanently removed on 2026-11-01.

Endpoint Updates

  • Precise Application Filtering (GET /v2/applications & GET /v2/applications/{id}): We have introduced new query parameters and response fields to replace state and currentStage:
    • hiringState: Use this to filter by or read the canonical hiring state.
      • Allowed values: APPLIED, ACTIVE, REJECTED, HIRED, OFFER.
    • stageType: Use this to filter by pipeline stage type.
      • Allowed values: APPLIED, APPLICATION_REVIEW, INTERVIEW, OFFER, HIRED.
    • pipelineStage: A new response object replacing the deprecated currentStage, providing the application's current pipeline stage details (id, name, type, order).
    • Important Usage Rules:
      • stageType must be combined with hiringState for precise filtering (e.g., hiringState=ACTIVE&stageType=INTERVIEW). It cannot be used on its own.
      • Neither of the new parameters can be combined with the deprecated state parameter.
      • State Parity: The values REJECTED, OFFER, and HIRED remain exactly the same whether sent through the deprecated state parameter or the new hiringState parameter.

Migration Path

Please transition your integrations to use the new fields before the removal date on 2026-11-01.

  • To filter for SCREENING: Use hiringState=ACTIVE combined with stageType=APPLICATION_REVIEW.
  • To filter for QUALIFIED: Use hiringState=ACTIVE combined with stageType=INTERVIEW.
  • To filter for REJECTED, OFFER, or HIRED: Simply pass these exact same values to the new hiringState parameter (e.g., hiringState=REJECTED).
  • To read current stage data: Read from the new pipelineStage object instead of currentStage in the response body.