Get all messages for a specific thread

GET

/openapi/message/threadmessages/{threadId}

const url = 'https://open-api.replyco.com/openapi/message/threadmessages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://open-api.replyco.com/openapi/message/threadmessages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns all messages (both customer-facing and internal notes) for a thread. Messages are ordered chronologically (oldest first).

Includes:

Customer messages
Internal notes
System messages
Attachments metadata
Sender information

Authorizations

Bearer

Parameters

Path Parameters

threadId

required

string format: uuid

Thread ID to retrieve messages from

Responses

200

Returns the list of thread messages

application/json

Array<object>

object

string format: uuid

text

string

nullable

messageDate

string format: date-time

nullable

status

integer format: int32

Allowed values: 0 - SentSuccesfully 1 - InProgress 2 - Failed 3 - Cancelled 4 - Delayed

title

string

nullable

references

Usually field contains List with MailMessageId of thread messages

Array<string>

nullable

uid

Mail Uid

integer format: int64

nullable

htmlBody

string

nullable

inReplyTo

string

nullable

isFromCompany

If we sent message then message id from company

boolean

nullable

unread

boolean

nullable

mailMessageId

string

nullable

threadId

string format: uuid

accountId

string format: uuid

marketplaceMessageId

string

nullable

responseEnabled

boolean

externalMessageId

Second type of MarketMessageID (needs when market Api use different types of message id for reply or other function)

string

nullable

languageCode

string

nullable

failMessage

string

nullable

userId

string format: uuid

nullable

senderAddress

string

nullable

language

integer format: int32

Allowed values: 0 - None 1 - Arabic 2 - Chinese 3 - Danish 4 - Dutch 5 - English 6 - French 7 - German 8 - Greek 9 - Hindi 10 - Italian 11 - Japanese 12 - Korean 13 - Norwegian 14 - Polish 15 - Portuguese 16 - Russian 17 - Spanish 18 - Swedish 19 - Turkish 20 - Ukrainian

messageTranslations

Array<object>

nullable

object

string format: uuid

messageId

string format: uuid

languageCode

string

nullable

translatedText

string

nullable

isHtml

boolean

attachments

Array<object>

nullable

An attachment as it is returned by the API. Unlike the request model it never carries the file content, so responses stay small. To download the original file, get a link from GET /openApi/byteFiles/messageAttachments/{messageId}/links.

object

url

Path of the stored file. Pass it back as ‘url’ on a later request to re-use the same file without uploading it again.

string

nullable

fileName

The name of the file including its extension (e.g., “invoice.pdf”, “image.jpg”)

string

nullable

previewId

ID of a small 180x120 cropped thumbnail of this attachment, available from GET /openApi/byteFiles/{id}. It is not the original file. Null when no thumbnail was generated (for example, for files hosted by eBay)

string format: uuid

nullable

sizeInKiloBytes

Size of the file in kilobytes

integer format: int32

nullable

Example

[
  {
    "status": "0 - SentSuccesfully",
    "language": "0 - None"
  }
]

401

User is not authenticated or authorized

403

User does not have access to this thread

404

Thread with the specified ID was not found