List a Slack integration's channels

GET/integrations/{integrationId}/channelsList a Slack integration's channels

Returns the channels the workspace bot is a member of for a Slack integration — the valid set of channel names to pass in the slackChannels shorthand when creating an assignment rule.

Only Slack integrations have channels: any other integration type returns 400 invalid_argument. The integration must be active — a disconnected, expired, or disabled one returns 409 conflict. Cross-tenant or unknown integration IDs return 404 not_found with no existence leak.

Parameters

integrationIdstring · uuidpathrequired

Integration UUID.

Responses

Headers

X-RateLimit-Limit

The request cap for the tighter of the per-organization / per-endpoint windows that applied to this request.

X-RateLimit-Remaining

Requests remaining in the current window.

X-RateLimit-Reset

Unix timestamp (seconds) when the current window resets.

value

allOf · 2 options

Option 1objectEnvelope

datavaluerequired

The response payload — shape depends on the endpoint.

metaobjectrequired

Pagination metadata — populated on list endpoints, empty on single-resource endpoints.

Show child attributes

cursornull | string

Opaque cursor to pass to the next request.

hasMoreboolean | null

True when further pages of results are available.

Option 2object

dataarray of object

Show child attributes

Show array items

A Slack channel the workspace bot is a member of. The `name` is what you pass in `slackChannels`.

idstringrequired

Slack's channel ID (e.g. `C0123ABCD`).

isExtSharedbooleanrequired

Whether the channel is shared with an external organization (Slack Connect).

isPrivatebooleanrequired

Whether the channel is private.

memberCountintegerrequired

Number of members in the channel.

namestringrequired

Channel name without the leading `#` (e.g. `general`).

Example response

{
  "data": [
    {
      "id": "C0123ABCD",
      "isExtShared": true,
      "isPrivate": true,
      "memberCount": 0,
      "name": "general"
    }
  ],
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "conflict",
    "message": "client is already deleted"
  }
}

Headers

Retry-After

Seconds the client should wait before retrying.

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Examples

integrationIdrequiredpath parameter

curl -X GET 'https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels'

const response = await fetch('https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.salfio.com/v1/integrations/00000000-0000-0000-0000-000000000000/channels");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "id": "C0123ABCD",
      "isExtShared": true,
      "isPrivate": true,
      "memberCount": 0,
      "name": "general"
    }
  ],
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "client is already deleted"
  }
}

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Search documentation

List a Slack integration's channels

Parameters

Responses

Headers

Headers

Documentation menu