Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-17611856.0 KB
letter

Info for a specific letter

get/letter/{letterId}

Path parameters

letterIdnumber required

The id of the letter to retrieve

Response

Expected response to a valid request

idstring letterId required
namestring required
direction'received' | 'send' required

Direction

channelstring channelId required

Channel

finalboolean

The status of the letter, e.g. deciding about visibility in the collection

datastring date-time

Date of receipt / Date of dispatch

identifierstring

External identifier of letter / case

descriptionnumber

Description ID choose by content creator

institutionnumber[]
casestring caseId
orderingnumber
commentstring
excerptstring
tagsstring[]
createdOnstring datetime required
createdBystring required

User ID responsible for creating the content

modifiedOnstring datetime required
modifiedBystring required