List threads

Lists conversations in the API key’s inbox. Each contact has one thread per inbox. By default only read and unread threads are returned. The x-helios-meta-count response header holds the total number of matches for paging.

GET/v1/threads

Query parameters

statusstring

Comma-separated thread statuses (`read`, `unread`, `archived`, `prospect`), or `all`. Defaults to `read,unread`.

querystring

Only return threads for contacts matching this name or phone number search. When set, the status filter is ignored.

userstring

Only return threads assigned to this team member ID. Use `null` for unassigned threads.

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 Thread

idstring

orgstring

gymstring

customerstring

The contact this conversation is with.

userstring

The team member the thread is assigned to, if any.

statusstring

Allowed:readunreadarchivedprospect

tagsstring[]

lastMessageobject

A summary of the most recent message.

Show properties

bodystring

datestring<date-time>

directionstring

Allowed:incomingoutgoing

protocolstring

Allowed:smsemailhttpvoip

mediaCountinteger

createdAtstring<date-time>

updatedAtstring<date-time>

Request

curl -X GET "https://api.sendhelios.com/v1/threads"

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

import requests

response = requests.get(
    "https://api.sendhelios.com/v1/threads",
)

Response

[
  {
    "id": "string",
    "org": "string",
    "gym": "string",
    "customer": "string",
    "user": "string",
    "status": "read",
    "tags": [
      "string"
    ],
    "lastMessage": {
      "body": "string",
      "date": "2024-01-01T00:00:00Z",
      "direction": "incoming",
      "protocol": "sms",
      "mediaCount": 0
    },
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
]