List support channels

GET/workspaces/{organizationId}/support-channels

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Responses

200

Support channels list

channelsobject[]required

Show properties

Array of object

One of:

object

typestringrequired

Allowed:email

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

emailAddressstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:slack

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

botTokenstring

ingestionModestring

Allowed:manualone_to_onetime_basedai

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:msteams

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:discord

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:chat

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

widgetIdstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:capture

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

formIdstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:api

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

endpointstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:intercom

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

appIdstring

accessTokenstring

adminIdstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:zendesk

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

subdomainstring

accessTokenstring

emailstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:plain

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

workspaceIdstring

accessTokenstring

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Request

curl -X GET 'https://pile.nyc/workspaces/string/support-channels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/support-channels", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/support-channels",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "channels": [
    {
      "type": "email",
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "isActive": true,
      "config": {
        "emailAddress": "string",
        "color": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}