v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List all the updated messages

get/v1/messages

Query parameters

min_updated_atstring

Specify the minimum time when the messages were updated at.

max_updated_atstring

Specify the maximum time when the messages were updated at.

per_pageinteger

The number of records to display per page.

page_nointeger

Denote the current page number.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the user who is accessing this endpoint.

Response

200

Example response

{
  "messages": [
    {
      "message": {
        "updated_at": "2017-05-10T21:02:31Z",
        "id": "layer:///messages/c0bb2a67-1bc4-4be6-9a8e-a986388be477",
        "sender_id": 1645,
        "recipient_id": 1591,
        "body": "Test1",
        "status": "read"
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2
  }
}