HMhm-courts-and-tribunals-service
application-codes

Get the exact saved Application Code by ID

Changed on

Returns the requested record, including historical or inactive versions. Unknown IDs return 404 without falling back to a code/date search. Fee metadata may be null when no matching fee exists.

get/application-codes/by-id/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /application-codes/by-id/{id}
  • Auth
    none declared

Path parameters

idinteger required

Primary key of the saved Application Code record.

Query parameters

datestring date

Date used only to resolve fee metadata through the existing fee-reference relationship. Defaults to the current UK business date. Does not filter the Application Code record.

Response

Application Code found

applicationCodestring required

Code that identifies the application.

titlestring required

Human-readable title.

isFeeDueboolean required

True if Application List Entries using this Application Code require an Application List Entry Fee Status to be created and linked.

requiresRespondentboolean required

True if Application List Entries using this Application Code require a respondent to be created and linked.

bulkRespondentAllowedboolean required

True if Application List Entries using this Application Code allow multiple respondents to be created and linked.

feeReferencestring nullable

A short reference code that identifies a Fee.

feeDescriptionstring nullable

Descriptive text for the fee.

offsiteFeeReferencestring nullable

A short reference code that identifies a offsite Fee.

offsiteFeeDescriptionstring nullable

Descriptive text for the offsite fee.

startDatestring date required

Date the Application Code became active.

endDatestring date nullable required

Date the Application Code became inactive. null indicates that this row is still active.

Example response

{
  "applicationCode": "AD99003",
  "title": "Application to Crown Court",
  "wording": {
    "template": "This is a test {{Applicant number}} with a date",
    "substitution-key-constraints": [
      {
        "key": "account-number",
        "value": "12345678",
        "constraint": {
          "type": "TEXT",
          "length": 1234
        }
      }
    ]
  },
  "feeReference": "CO5.2",
  "feeAmount": {
    "value": 1299,
    "currency": "GBP"
  },
  "feeDescription": "Fee for application to Crown Court",
  "offsiteFeeReference": "CO5.2",
  "offsiteFeeAmount": {
    "value": 1299,
    "currency": "GBP"
  },
  "offsiteFeeDescription": "Offsite Fee for application to Crown Court",
  "startDate": "2025-09-17",
  "endDate": "2025-12-01"
}

Changes