Sign in
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'

Response

countnumber required

Changes

Changed in 1 of the 2 revisions of this API.11

  • 9ebfeee0006911See the full diff
    • ▲

      removed the required property grantApplications from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property applications to the response with the 200 status

      response-required-property-added