Messages

Retrieve a message. This endpoint needs to be called with an API key with sufficient permissions for the requested message.

Request

Endpoint

GET /v1/messages/{messageId}

Path Parameters

Name	Type	Description
messageId `required`	string	Universal Unique Identifier for the message e.g. `338ba7d5-4e7a-4784-9162-72dadd6233a8`

Response

HTTP Status code

200

Body

{
  "data": {
    "id": "9890ed24-405d-4688-abcd-b7f829d75939",
    "sender": {
      "id": "9890ed24-405d-4688-abcd-b7f829d75939",
      "firstName": "Alice",
      "lastName": "Baker"
    },
    "patient": {
      "id": "9890ed24-405d-4688-abcd-b7f829d75939",
      "firstName": "Alice",
      "lastName": "Baker"
    },
    "content": "This is a sample message content.",
    "readAt": "2024-09-17T15:45:00+02:00",
    "timestamp": "2024-09-17T15:45:00+02:00"
  }
}

Example

GET /v1/messages/338ba7d5-4e7a-4784-9162-72dadd6233a8 HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com

HTTP/1.1 200 OK
Date: Wed, 30 Apr 2024 11:03:24 GMT
Content-Type: application/json

{"data":{"id":"9890ed24-405d-4688-abcd-b7f829d75939","sender":{"id":"9890ed24-405d-4688-abcd-b7f829d75939","firstName":"Alice","lastName":"Baker"},"patient":{"id":"9890ed24-405d-4688-abcd-b7f829d75939","firstName":"Alice","lastName":"Baker"},"content":"This is a sample message content.","readAt":"2024-09-17T15:45:00+02:00","timestamp":"2024-09-17T15:45:00+02:00"}}