latestOpenAPI 3.0.02026-08-1091511.8 KB
2be4d84cb330
Applications
Get all applications
get/v1/applications
Query parameters
supportSchemeIdsstring
Search by support scheme IDs
searchstring
Search by client name, email or application reference
status'INVITED' | 'STARTED' | 'SUBMITTED' | 'AWAITING_HOUSEHOLD' | 'INFO_REQUESTED' | 'REVIEWED' | 'DECLINED' | 'APPROVED' | 'OPTED_OUT' | 'INACTIVE' | 'INELIGIBLE'
Filter by application status
latestSubmissionFromstring date-time
Filter by latest submission date from (ISO 8601 timestamp)
latestSubmissionTostring date-time
Filter by latest submission date to (ISO 8601 timestamp)
pagenumber
pageSizenumber
sortKey'clientName' | 'supportScheme' | 'reference' | 'createdAt' | 'firstSubmissionAt' | 'latestSubmissionAt'
sortOrder'DESC' | 'ASC'