Start free trial

List match candidates for a session

GET/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/candidates

Impact-sorted (amount desc), cursor-paginated. Filter by case (internal_transfer | parent_intercompany | data_gap | hidden_detail) and status (proposed | confirmed | rejected | applied).

Operation ID: list_session_candidates_api_v1_advisory_firms__firm_id__cleanup_sessions__session_id__candidates_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_idstringrequired
session_idstringrequired

Query

casestring

Filter by case type

statusstring

Filter by status

cursorstring
limitintegerdefault: 50
directionstringdefault: next

Responses

200Successful Response

Schema: SuccessEnvelope_MatchCandidateListResponse_

successboolean
messagestring
codestring
dataMatchCandidateListResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject