Appearance

Get Channels ​

Endpoint ​

http
GET /unified/instant-messaging/channels/{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
object

Workspace to which the channel belongs.

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

Unique identifier for the workspace.

name
string

Name of the workspace.

type
string

Type of the channel.

All possible enum values:
  • channel
  • dm
  • group_dm
  • private_channel
Enum support by integration
  • Microsoft Teams
    • channel
    • dm
    • group_dm
  • Microsoft 365
    • channel
    • dm
    • group_dm
Supported in
  • Microsoft 365
  • Microsoft Teams

Response Body ​

id
string
REQUIRED · 

Unique identifier for the channel.

Supported in
  • Microsoft 365
  • Microsoft Teams
name
string

Name of the channel.

Supported in
  • Microsoft 365
  • Microsoft Teams
description
string

Description of the channel.

Supported in
  • Microsoft 365
  • Microsoft Teams
organization
object

Organization to which the channel belongs.

id
string

Unique identifier for the organization.

name
string

Name of the organization.

workspace
object

Workspace to which the channel belongs.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

group
object

Group to which the channel belongs.

Supported in
  • Microsoft 365
  • Microsoft Teams
id
string

Unique identifier for the group.

name
string

Name of the group.

type
string

Type of the channel.

All possible enum values:
  • channel
  • private_channel
  • dm
  • group_dm
Supported in
  • Microsoft 365
  • Microsoft Teams
status
string

Status of the channel.

All possible enum values:
  • active
  • archived
Supported in
  • Microsoft 365
  • Microsoft Teams
is_member
boolean

Is the current authed user or application is a member of the channel. This might not directly mean that the user or application can post messages on the channel.

created_by
object
id
string

Unique identifier for the member.

created_at
string · date-time

Date and time when the channel was created.

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

Date and time when the channel was last updated.

remote_data
object

Raw data returned from the remote API call.