Appearance

List Messages ​

Endpoint ​

http
GET /unified/instant-messaging/messages
Integrations supported
  • Microsoft Teams
  • Slack

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
channel
object

Channel to which the message belongs.

Required in
  • Microsoft Teams
  • Slack
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
workspace
Required in
  • Microsoft Teams
id
REQUIRED · 

Response Body ​

result
object[]

List of Messages

id
string
REQUIRED · 

Unique identifier for the message.

Supported in
  • Microsoft Teams
  • Slack
body
object

Body of the message.

Supported in
  • Microsoft Teams
  • Slack
format
string

Format of the message body.

content
string

Content of the message body.

attachments
object[]

Attachments of the message.

Supported in
  • Microsoft Teams
  • Slack
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 Teams
  • Slack
id
string

Unique identifier for the author.

name
string

Name of the author.

channel
object

Channel to which the message belongs.

Supported in
  • Microsoft Teams
  • Slack
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 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.

Supported in
  • Slack
created_at
string · date-time

Date and time when the message was created.

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

Date and time when the message was last updated.

Supported in
  • Microsoft Teams
  • Slack
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.