ePost Digital Letterbox

Get a letter of current user with given id.

get/epost/v2/letters/{letter-id}

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/v2/letters/{letter-id}
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Path parameters

letter-idstring required
Example:1

The id of the letter

Response

Retrieve letter successfully.

idstring

Id of the letter.

letterTitlestring

This is the letter title.

fileNamestring

This is the name of the reference file of the letter.

senderParticipantIdstring

The participant id of the sender.

senderUserIdstring

The sender user id of the letter.

senderCaseIdstring

The sender case id of the letter.

senderEndToEndIdstring

The sender end to end id of the letter.

documentTypesstring[]

Types of the letter's document.

letterContentReferencestring

This is the reference link that user can use to get to content of the letter.

letterType'CLASSIC_LETTER' | 'SMART_LETTER' | 'SMART_LETTER_ANSWER' | 'SIMPLE_SHORT_MESSAGE' | 'INCAMAIL' | 'SECURESEND'

The letter type.

receivedDateTimestring

The date and time (yyyy-MM-dd'T'HH:mm:ssZ) that the letter was received.

documentMessagestring

The message content of the simple short message

descriptionstring

Free-text description shown alongside the letter in eArchive. Sourced from the description supplied at upload time.

readStatus'READ' | 'UNREAD'

The read status of the document.

remainingDayToDeleteinteger

The remaining days before permanently delete

registeredStatusstring

The current registration status

eLetterRegisteredboolean

Letter is registered or not

Example response

{
  "id": "1",
  "letterTitle": "eVoting questionnaire",
  "fileName": "invoice.pdf",
  "senderParticipantId": "b0f742a3-0a54-401d-bf41-38a3a9628953",
  "senderUserId": "84332810",
  "senderCaseId": "8wq2d8ca",
  "senderEndToEndId": "4ffdec250928157ec24ef24716468b0f25f074e6",
  "documentTypes": [
    "contract",
    "invoice"
  ],
  "letterContentReference": "https://api.klara.ch/epost/v2/letters/1/content",
  "letterType": "CLASSIC_LETTER",
  "receivedDateTime": "2021-09-29T04:21:10.163Z",
  "documentMessage": "Dear Peter \n Your appointment on 28.05.2022 has been cancelled. Please contact us to arrange a new one",
  "description": "Monthly invoice file",
  "readStatus": "READ",
  "remainingDayToDelete": 30,
  "registeredStatus": "PENDING | ACCEPTED | LEGALLY_ACCEPTED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.