standard-applicants

Get Standard Applicants (paginated, filterable)

Changed on

Returns 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
get/standard-applicants

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /standard-applicants
  • Auth
    none declared

Query parameters

codestring

Filter by code (contains, case-insensitive).

namestring
Example:Innovative Solutions Inc

Filter by name (contains, case-insensitive). Searches organisation/name, surname, forename 1, forename 2 and forename 3.

addressLine1string

Filter by address line 1 (contains, case-insensitive).

fromstring date

Filter by from date. If supplied after to, the API normalises the range before searching.

tostring date

Filter by to date. If supplied before from, the API normalises the range before searching.

pageNumberinteger

Zero-based page index.

pageSizeinteger

Page size.

sortstring[]

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.

pageNumberinteger required

Zero-based page index.

pageSizeinteger required

Page size.

totalElementsinteger required

Total number of elements across all pages.

totalPagesinteger

Total number of pages.

firstboolean
lastboolean
elementsOnPageinteger required

Total number of elements in the current page.

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