v2

latestOpenAPI 3.0.3raw.githubusercontent.com2026-02-044510.9 KB

Letters

Get all letters for a user

Returns all letters belonging to the specified user across all cases.

get/letters/{userId}

Response

List of letters for the user.

userIdstring uuid required

Unique identifier of the user who owns the letter.

caseReferenceNumberstring required

Reference number of the case to which the letter belongs.

letterIdstring uuid required

Unique identifier of the letter.

letterTypestring required

Code that identifies which letter template was used.

letterDataLetterData required

Dynamic key-value pairs used to populate the letter template. Required fields will vary depending on letterType.

Example response

[
  {
    "userId": "223e4567-e89b-12d3-a456-426614174111",
    "caseReferenceNumber": "25-700123",
    "letterId": "123e4567-e89b-12d3-a456-426614174000",
    "letterType": "AA01",
    "letterData": {
      "recipientName": "Mr Test Testcase",
      "caseReference": "25-700123",
      "decisionDate": "2024-01-15"
    }
  }
]