Appearance

Get Messages ​

Endpoint ​

http
GET /unified/instant-messaging/messages/{id}
Integrations supported
  • Microsoft 365
  • Microsoft Teams

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
workspace
Required in
  • Microsoft 365
  • Microsoft Teams
id
REQUIRED · 
channel
object

Channel to which the message belongs.

Required in
  • Microsoft 365
  • Microsoft Teams
id
string
REQUIRED · 

Unique identifier for the channel.

name
string

Name of the channel.

type
string
REQUIRED · 

Type of the channel.

All possible enum values:
  • channel
  • dm
  • group_dm

Response Body ​

id
string
REQUIRED · 

Unique identifier for the message.

Supported in
  • Microsoft 365
  • Microsoft Teams
body
object

Body of the message.

Supported in
  • Microsoft 365
  • Microsoft Teams
format
string

Format of the message body.

content
string

Content of the message body.

attachments
object[]

Attachments of the message.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the attachment.

name
string

Name of the attachment.

type
string

Type of the attachment.

url
string

URL of the attachment.

author
object

Author of the message. Is a member object.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the author.

name
string

Name of the author.

channel
object

Channel to which the message belongs.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the channel.

name
string

Name of the channel.

type
string

Type of the channel.

parent
object

Parent entity of the message.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the parent entity.

type
string

Type of the parent entity.

All possible enum values:
  • message
has_children
boolean

Whether the message has children.

created_at
string · date-time

Date and time when the message was created.

Supported in
  • Microsoft 365
  • Microsoft Teams
updated_at
string · date-time

Date and time when the message was last updated.

Supported in
  • Microsoft 365
  • Microsoft Teams
remote_data
object

Raw data returned from the remote API call.