v1

latestSwagger 2.0raw.githubusercontent.com2025-02-1913619.7 KB
applications

Return a pruned version of the applications with pagination.

get/api/v1/applications

Query parameters

sort_by'applicant_name' | 'application_type' | 'case_type' | 'office_code' | 'reference' | 'return_reason' | 'returned_at' | 'reviewed_at' | 'submitted_at'

Column to sort by the records.

sort_direction'desc' | 'asc' | 'descending' | 'ascending'

Sorting direction for the records.

pageinteger

Page to fetch.

per_pageinteger

Number of results to return per page.

status'submitted' | 'returned' | 'superseded'

The status of the application.

office_codestring

The office account number handling the application.

Response

Return a pruned version of the applications with pagination.