GET /standard-applicants/export
Changed onExport all matching currently active Standard Applicants, across all pages, to a CSV file. Contains exactly four columns: Applicant Code, Name, Use From and Use To. Personal names, titles, addresses, postcodes, email and telephone/mobile numbers are never exported. Uses the same code/name matching and ordering as search without date filters. Code and name are optional and may be combined; both must match when supplied together. Omitting both returns all currently active applicants. Defaults to code ascending.
- 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/export
- Authnone declared
Query parameters
Filter by code (contains, case-insensitive). May be combined with name.
Filter by organisation or person name (contains, case-insensitive). May be combined with code.
One sort value: code, name, addressLine1, from or to, followed by asc or desc (for example name,desc). Defaults to code,asc.
Response
A CSV file containing the filtered list of Standard Applicants.
Changes
- info
added the new optional
queryrequest parametersort - info
removed the non-success response with the status
- info
- info
endpoint added
- info