Get Standard Applicants (paginated, filterable)
Changed onReturns a paginated list of Standard Applicants.
- Filters:
- code – case-insensitive partial match
- name – case-insensitive partial match against organisation/name, surname and forenames 1-3
Request
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- URL/standard-applicants
- Authnone declared
Query parameters
Filter by code (contains, case-insensitive).
Filter by name (contains, case-insensitive). Searches organisation/name, surname, forename 1, forename 2 and forename 3.
Filter by address line 1 (contains, case-insensitive).
Filter by from date. If supplied after to, the API normalises the range before searching.
Filter by to date. If supplied before from, the API normalises the range before searching.
Zero-based page index.
Page size.
Sort parameter. Format: property,(asc|desc). Currently only a single sort value is supported. Example: ?sort=name,asc. Supported properties:
- code
- name
- addressLine1
- from
- to
[ "name,asc" ]
Response
Page of Standard Applicants.
Example response
{
"sort": {
"orders": [
{
"property": "title",
"direction": "asc"
},
{
"property": "code",
"direction": "desc"
}
]
},
"content": [
{
"code": "STANDARD-1",
"name": "Standard Applicant 1",
"startDate": "2025-12-01",
"endDate": "2025-12-01"
}
]
}Changes
- warning
removed the optional property
///from the response with the status - info
added the optional property
///to the response with the status - info
the response property
///became required for the status
- warning