Skip to main content
GET
Get administration message by id

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Path Parameters

id
string
required

Message identifier

Query Parameters

administration_id
string
required

Administration identifier

fields
string

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

Response

Message

CustomerApi_V1_MessageEntity model

sender_type
string
required

Sender type (creditor|debtor)

administration_id
string
required

Owning administration identifier

id
string
required

Unique identifier

updated_at
string<date-time>
required

Timestamp at which the message was last updated

subject
string

Message subject

read_by_user
object

User who marked the message as read

sent_by_user
object

Creditor user who sent the message

credit_case_id
string

Associated credit_case identifier

debtor_id
string

Associated debtor identifier

invoice_id
string

Associated invoice identifier

content
string

The content of the message (request with the 'fields' parameter)

sent_at
string<date-time>

Timestamp at which the message was sent

received_at
string<date-time>

Timestamp at which the message was received

read_at
string<date-time>

Timestamp at which the message was first read (please note that for some mail clients this field is not filled when an email is read)

Last modified on August 13, 2026