HMhm-courts-and-tribunals-service
application-list-entries

Get an Application List Entry by id

Changed on

Returns a detailed Application List Entry while the parent Application List is in a state that permits standard entry access. Closed lists must be updated via the dedicated closed-entry endpoint and may reject this standard detail endpoint with 409 Conflict.

get/application-lists/{listId}/entries/{entryId}

Request

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

Path parameters

listIdstring uuid required

Public identifier of the Application List.

entryIdstring uuid required

Public identifier of the Application List Entry.

Response

Returns a detailed Application List Entry

idstring uuid required

Unique identifier of the Application List Entry.

listIdstring uuid required

The Unique identifier of the Application List this Entry belongs to.

standardApplicantCodestring

Code that identifies the Standard Applicant.

standardApplicantIdinteger nullable

ID that identifies the Standard Applicant.

applicationCodeIdinteger required

ID of the exact persisted Application Code association, including historical versions.

applicationCodestring required

Code that identifies the Application Code.

numberOfRespondentsinteger nullable required

Number of respondents required by the Application.

hasOffsiteFeeboolean

Indicates whether an off-site fee applies.

caseReferencestring

A reference code to identify a related case (maximum 15 characters).

accountNumberstring

The Applicants account number (maximum 20 characters).

notesstring

Notes about the application or the hearing (maximum 4000 characters).

lodgementDatestring date required

The date on which the application was submitted. Will be set to current date if omitted.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "listId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "standardApplicantCode": "APP001",
  "applicationCode": "APP001",
  "applicant": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "respondent": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      },
      "dateOfBirth": "1990-01-01"
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "wording": {
    "template": "This is a test {{Applicant number}} with a date",
    "substitution-key-constraints": [
      {
        "key": "account-number",
        "value": "12345678",
        "constraint": {
          "type": "TEXT",
          "length": 1234
        }
      }
    ]
  },
  "feeStatuses": [
    {
      "paymentReference": "PAY-001",
      "paymentStatus": "PAID",
      "statusDate": "2025-12-01"
    }
  ],
  "hasOffsiteFee": true,
  "caseReference": "CASE-001",
  "accountNumber": "ACC-001",
  "notes": "Time is 10:31, we have convened to talk about Application...",
  "lodgementDate": "2025-12-01",
  "officials": [
    {
      "title": "Mr, Mrs",
      "surname": "Smith",
      "forename": "John",
      "type": "MAGISTRATE"
    }
  ]
}

Changes