Get Team Channels - Teamly API

Request

Path Params

teamId

string

required

Header Params

Authorization

string

required

Default:

Bot {token}

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

channels

array[object (Channel) {14}]

required

id

string

required

Unique identifier for the channel

type

string

required

Type of the channel

teamId

string

required

ID of the team to which the channel belongs

name

string

required

Name of the channel

>= 1 characters<= 20 characters

description

string | null

optional

Description of the channel. Can be null if no description is provided

createdBy

string

required

ID of the user who created the channel

parentId

string | null

optional

ID of the parent channel if it's a subchannel. Can be null if not applicable

participants

array[string] | null

optional

If the channel is a voice channel, it must return the participants of the voice channel

priority

number

required

Priority of the channel, indicating its position or importance

nsfw

boolean

required

Indicates whether the channel is NSFW (Not Safe For Work)

region

string | null

optional

Region of voice channel

createdAt

string <date-time>

required

Timestamp of when the channel was created

permissions

object

required

Permissions for the channel, containing roles and their associated permissions

additionalData

object | null

optional

Additional data

categories

array[object (Category) {8}]

required

id

string

required

Unique identifier for the category

teamId

string

required

ID of the team associated with the category

name

string

required

Name of the category

createdBy

string

required

ID of the user who created the category

priority

number

optional

Priority level of the category

Default:

null

permissions

object

required

Permissions for the channel, containing roles and their associated permissions

createdAt

string <date-time>

required

Timestamp of when the category was created

Default:

CURRENT_TIMESTAMP

editedAt

string <date-time>

optional

Timestamp of when the category was last edited

Default:

null

Example

{
  "channels": [
    {
      "id": "string",
      "type": "string",
      "teamId": "string",
      "name": "string",
      "description": "string",
      "createdBy": "string",
      "parentId": "string",
      "participants": [
        "string"
      ],
      "priority": 0,
      "nsfw": true,
      "region": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "permissions": {
        "role": {
          "roleId": "string",
          "allow": 0,
          "deny": 0
        }
      },
      "additionalData": {
        "streamChannel": "string",
        "streamPlatform": "string"
      }
    }
  ],
  "categories": [
    {
      "id": "string",
      "teamId": "string",
      "name": "string",
      "createdBy": "string",
      "priority": null,
      "permissions": {
        "role": {
          "roleId": "string",
          "allow": 0,
          "deny": 0
        }
      },
      "createdAt": "CURRENT_TIMESTAMP",
      "editedAt": null
    }
  ]
}