Skip to content
Updawg

`GET /v1/orgs/{org}/slack/installations/{installation_id}/channels`.

GET
/v1/orgs/{org}/slack/installations/{installation_id}/channels
curl --request GET \
  --url https://api.updawg.net/v1/orgs/example/slack/installations/example/channels

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

installation_id
required
string

The sli_… id.

Responses

Section titled “Responses”

200

Section titled “200”

The workspace’s public channels that are not archived, by name: at most 2,000, and truncated when there are more.

Media typeapplication/json

The channels, by name.

object
channels
required
Array<object>

A public channel in the workspace, for the portal’s channel picker.

object
id
required

C…: what a slack_app channel’s channel takes.

string
is_member
required

Whether the app is in it already. It posts to a public channel either way.

boolean
is_private
required

Always false: only public channels are listed, because the app can post only to a private one it has been invited to.

boolean
name
required

Without the #.

string
num_members
integer | null format: int64
truncated
required

The workspace has more public channels than the 2,000 listed: one not here can still be typed by name or id.

boolean

Example generated

{
  "channels": [
    {
      "id": "example",
      "is_member": true,
      "is_private": true,
      "name": "example",
      "num_members": 1
    }
  ],
  "truncated": true
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Not permitted for this role, or the plan does not include chat notifications: plan-required.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such installation here.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

The app’s token cannot list channels: removed in Slack, or installed before the app asked for channels:read. slack-reinstall-needed; installing again fixes it.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

421

Section titled “421”

The organization’s data is in another region (wrong-region, DAWG-159). detail names that region’s API; send the request there.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

503

Section titled “503”

This deployment has no Slack app (slack-unavailable), or Slack is rate limiting it (slack-busy, with Retry-After).

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}