---
updatedAt: 2026-09-11T05:21:04.000Z
agentTools:
  projectIndex: https://developer.doit.com/llms.txt
---

# List eligible Slack destinations

Lists Slack destinations eligible for Alert notifications for the authenticated customer and caller. Returns canonical identifiers for recipientsSlackChannels and integration status. User credentials include visible private channels; service accounts return public/shared channels only. Results are sorted by stable destination identity. Keep nameContains unchanged when following pageToken.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "DoiT Cloud Intelligence",
    "description": "Programmatic access to DoiT Platform",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.doit.com"
    }
  ],
  "security": [
    {
      "api_key": []
    },
    {
      "tenantId": [],
      "api_key": []
    }
  ],
  "tags": [
    {
      "name": "Alerts",
      "description": "Notifications triggered when cloud costs exceed defined thresholds or meet specific conditions."
    }
  ],
  "paths": {
    "/analytics/v1/alerts/slack-channels": {
      "get": {
        "tags": [
          "Alerts"
        ],
        "summary": "List eligible Slack destinations",
        "operationId": "listAlertSlackChannels",
        "description": "Lists Slack destinations eligible for Alert notifications for the authenticated customer and caller. Returns canonical identifiers for recipientsSlackChannels and integration status. User credentials include visible private channels; service accounts return public/shared channels only. Results are sorted by stable destination identity. Keep nameContains unchanged when following pageToken.",
        "parameters": [
          {
            "name": "nameContains",
            "in": "query",
            "schema": {
              "type": "string",
              "description": "Case-insensitive substring of the channel display name."
            }
          },
          {
            "name": "maxResults",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500,
              "default": 50
            }
          },
          {
            "$ref": "#/components/parameters/pageToken"
          }
        ],
        "responses": {
          "200": {
            "description": "Eligible channels and connection status.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AlertSlackChannelList"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "503": {
            "description": "Slack discovery is temporarily unavailable — the workspace is still connected, but the channel lookup failed (rate limit, timeout, server error, or network failure) after a server-side retry, or a pagination-snapshot read failed. This is retryable: when Retry-After is present, wait that many seconds and repeat the request unchanged, including nameContains and pageToken. When absent, use exponential backoff.",
            "headers": {
              "Retry-After": {
                "description": "Seconds to wait before retrying. Present on rate-limit failures; absent on other transient errors.",
                "schema": {
                  "type": "integer",
                  "example": 30
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AlertSlackChannelRequest": {
        "type": "object",
        "required": [
          "id"
        ],
        "description": "Slack destination selected for an alert. Exactly one of the two shapes is valid: a shared channel (`shared: true`, `workspace` omitted), or a workspace channel (`shared: false` or omitted, `workspace` required). Any other combination is rejected with `validation_failed`. Identity is id plus workspace/shared context. customerId defaults to the authenticated customer; an explicit mismatch is rejected. Service accounts can add public/shared destinations; new private destinations require a user credential with channel visibility.",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "workspace": {
            "type": "string",
            "description": "Connected workspace name returned by discovery. Required for a non-shared channel."
          },
          "shared": {
            "type": "boolean",
            "default": false
          },
          "customerId": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "AlertSlackChannel": {
        "description": "Eligible Slack destination returned by listAlertSlackChannels and echoed on alert responses. Name and type are canonical display metadata resolved server-side; values supplied on a request are ignored. Existing unavailable destinations may be retained or removed.",
        "allOf": [
          {
            "$ref": "#/components/schemas/AlertSlackChannelRequest"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Display name, resolved server-side."
              },
              "type": {
                "type": "string",
                "description": "Channel visibility, resolved server-side.",
                "enum": [
                  "public",
                  "private"
                ]
              }
            }
          }
        ]
      },
      "AlertSlackChannelList": {
        "type": "object",
        "required": [
          "items",
          "rowCount",
          "workspaceStatus",
          "isWorkspaceConnected",
          "hasSharedChannel",
          "channelsComplete"
        ],
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AlertSlackChannel"
            }
          },
          "rowCount": {
            "type": "integer",
            "description": "Total eligible channels after filtering and before pagination."
          },
          "pageToken": {
            "type": "string",
            "description": "Opaque continuation token. Omitted on the final page."
          },
          "workspaceStatus": {
            "type": "string",
            "enum": [
              "none",
              "ok",
              "inactive",
              "missing_private_scope"
            ],
            "description": "Integration status. Reconnect for inactive; grant private-channel scopes for missing_private_scope. None means no usable workspace was found; a shared channel may still be available."
          },
          "isWorkspaceConnected": {
            "type": "boolean"
          },
          "hasSharedChannel": {
            "type": "boolean"
          },
          "channelsComplete": {
            "type": "boolean",
            "description": "Whether the channel list is complete. False when a transient Slack failure prevented a full listing; callers that validate channel availability should not treat a partial list as authoritative."
          }
        }
      },
      "Error": {
        "type": "object",
        "description": "Standard error response structure.",
        "properties": {
          "error": {
            "type": "string",
            "description": "Detailed error message."
          }
        },
        "example": {
          "error": "The request could not be completed."
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request - The server cannot process the request, often due to a malformed request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized - Invalid API key.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden - The client is not authorized to perform the request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "parameters": {
      "pageToken": {
        "name": "pageToken",
        "in": "query",
        "description": "Page token, returned by a previous call, to request the next page of results",
        "schema": {
          "type": "string"
        }
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "Authorization",
        "description": "Use the \"Bearer <API_KEY>\" format or sign in for autofill",
        "in": "header"
      },
      "tenantId": {
        "type": "apiKey",
        "name": "X-Tenant-Id",
        "description": "Customer (tenant) ID for the request. Separate from your API token: always authenticate with `Authorization: Bearer <token>` (personal or service account). See [Get Started](https://developer.doit.com/docs/start). Omit when your token is scoped to a single customer (resolved automatically). A service account can select an active direct or nested descendant of its home customer; the endpoint's normal permissions, entitlements, and resource-ownership checks still apply. A service-account target outside that customer subtree returns `403 Forbidden`. Prefer this header over the legacy `customerContext` query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.",
        "in": "header"
      }
    }
  },
  "x-samples-languages": [
    "curl",
    "go",
    "node",
    "python"
  ],
  "x-cli-config": {
    "security": "oauth2",
    "params": {
      "client_id": "cli"
    }
  }
}
```