ePost Digital Letterbox

Get letters of current user.

get/epost/v2/letters

Request

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

Query parameters

from-datestring

Filter letters with the send date (yyyy-MM-dd). Letters were sent since 'from-date' value will be return.<br/>Both <b>from-date</b> and <b>to-date</b> need to be specified to filter letters within a time period.<br/>Example: 2021-10-01

is-business-tenantboolean
letter-folder'INBOX_FOLDER' | 'SENT_FOLDER'

Filter letters in specific folder<br/>Acceptable values:<br/><b>INBOX_FOLDER</b> for inbox letters<br/><b>SENT_FOLDER</b> for outbox letters<br/><br /><br/><b>INBOX_FOLDER</b> is chosen <b>by default</b>

letter-typesLetterType[] required

Filter letters with this media type<br/>Acceptable values:<br/><b>CLASSIC_LETTER</b> for classic letters<br/><b>SMART_LETTER</b> for smart letters<br/><b>SMART_LETTER_ANSWER</b> for smart letter answers<br/><b>SIMPLE_SHORT_MESSAGE</b> for simple short message<br/><b>INCAMAIL</b> for IncaMail<br/><b>SECURESEND</b> for SecureSend<br /><br/><b>CLASSIC_LETTER</b> is chosen <b>by default</b>

limitinteger

Define the limit of the letter list that this API returns.<br />For example, if a user have 20 letters in their inbox, and this <b>limit</b> parameter is 5, and the <b>offset</b> parameter is 0,<br />then this API will return letter list containing the first 5 letters<br />If not set, then default value of 48 is used

offsetinteger

Define which position to start getting letter list.<br />For example, if a user have 20 letters in their inbox, and this <b>offset</b> parameter is 5,<br />then this API will return letter list from the 5th letter.<br />If not set, then default value of 0 is used

read-status'READ' | 'UNREAD' | 'ALL'

Filter letters with read status<br/>Acceptable values:<br/><b>READ</b> for read letters<br/><b>UNREAD</b> for unread letters<br/><b>ALL</b> for all letters<br/><b>ALL</b> is chosen <b>by default</b>

senderCaseIdstring

Filter letters with sender case id

senderEndToEndIdstring

Filter letters with sender end to end id

senderParticipantIdstring

Filter letters with sender participant id

senderUserIdstring

Filter letters with sender user id

to-datestring

Filter letters with the send date (yyyy-MM-dd). Letters were sent before 'to-date' value will be return<br/>Both <b>from-date</b> and <b>to-date</b> need to be specified to filter letters within a time period.<br/>Example: 2021-10-01

with-reminderboolean

Response

Retrieve letters 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.