Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

List support channels

GET/workspaces/{organizationId}/support-channels
Path parameters
organizationIdstringrequired
Responses
200Support 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
Parameters
Request
curl -X GET "/workspaces/string/support-channels"
Response
{
  "channels": [
    {
      "type": "email",
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "isActive": true,
      "config": {
        "emailAddress": "string",
        "color": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}