Get content
GET/v1/content/document/:id
Please note that for security reasons, not all fields are returns. As a sender you won't have access to receiver_state, and as receiver no access to the sender_state.
read is set to true once, the document was opened for the first time either by the mobile or webclient or via the API using the read flag. Once it is set to true it cannot be set to false.
Request
Path Parameters
document ID
Responses
- 200
- 401
- 404
Content response
- application/json
- Schema
- Example (from schema)
Schema
content
object
meta
object
Possible values: [unread
, read
, archived
, trashed
, registering
, deleted
, pending
]
The state of the receiver, it is only return if the user is the receiver of the message
Possible values: [active
, archived
, trashed
, deleted
, pending
]
The state of the sender, it is only return if the user is the sender of the message
{
"content": {
"content": "string",
"content_type": "string"
},
"meta": {
"delivered": true,
"delivered_date": "2024-04-29T20:25:43.606150Z",
"read": true,
"read_date": "2024-04-29T20:25:50.475815Z",
"receiver": "2802510314782548",
"receiver_state": "unread",
"sender": "c00d790d-b4ec-4908-a52d-6eba3d53953c",
"sender_state": "active",
"sent_date": "2024-04-29T20:25:43.606150Z",
"size": 123765,
"subject": "Test Betreff",
"type": "letter"
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 40103,
"message": "access not granted",
"status": 401
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 40400,
"message": "not found",
"status": 404
}