List messages

Lists the messages in one thread, in both directions. Pass sort=-createdAt to get the newest messages first. The x-helios-meta-count response header holds the total number of matches for paging.

GET/v1/messages

Query parameters

threadstringrequired

The thread ID. Webhook payloads for incoming messages include it as `data.message.thread`.

limitinteger

Maximum number of results to return. Page through large result sets with `limit` and `offset`; 100 per page is a good default.

min 1

offsetinteger

Number of results to skip.

min 0 · default: 0

sortstring

Field to sort by. Prefix with `-` for descending order, for example `-createdAt`.

Responses

200Successful response

Array of Message

idstring

orgstring

gymstring

threadstring

customerstring

userstring

The team member who sent the message, for messages sent from the inbox.

flowstring

The flow that sent the message, if any.

listMessagestring

The blast that sent the message, if any.

bodystring

subjectstring

Email subject, for email messages.

directionstring

Allowed:incomingoutgoing

statusstring

Allowed:queuedscheduledsendingsentfailed

protocolstring

`http` is used for form submissions.

Allowed:smsemailhttpvoip

providerstring

Allowed:heliostwiliopostmark

providerIdstring

The delivery provider's ID for the message.

segmentsinteger

Billable SMS segments.

mediaobject[]

Show properties

Array of object

contentTypestring

urlstring

linksobject[]

Tracked short links in the message body.

Show properties

Array of object

pathstring

urlstring

scheduleDatestring<date-time>

createdAtstring<date-time>

updatedAtstring<date-time>

403The thread belongs to a different inbox

Request

curl -X GET "https://api.sendhelios.com/v1/messages?thread=string"

const response = await fetch("https://api.sendhelios.com/v1/messages?thread=string", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.sendhelios.com/v1/messages?thread=string",
)

Response

[
  {
    "id": "string",
    "org": "string",
    "gym": "string",
    "thread": "string",
    "customer": "string",
    "user": "string",
    "flow": "string",
    "listMessage": "string",
    "body": "string",
    "subject": "string",
    "direction": "incoming",
    "status": "queued",
    "protocol": "sms",
    "provider": "helios",
    "providerId": "string",
    "segments": 0,
    "media": [
      {
        "contentType": "string",
        "url": "string"
      }
    ],
    "links": [
      {
        "path": "string",
        "url": "string"
      }
    ],
    "scheduleDate": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
]