Read thread

GET/v1/threads/{id}

Path parameters

idstringrequired

Responses

200Successful response

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>

403The thread belongs to a different inbox

Request

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

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

import requests

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

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"
}