channels.getChannel

GET

/v1/organization/channels/{channelId}

const url = 'https://example.com/v1/organization/channels/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/organization/channels/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

channelId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed values: slack lark telegram custom

name

required

string

agent

required

string

>= 1 characters <= 128 characters

actor

required

string

enabled

required

boolean

linkPath

required

Any of:

string
null

string

webhookUrl

required

string

credentials

required

Any of:

object

kind

required

string

Allowed values: slack

botToken

required

object

set

required

boolean

hint

required

Any of:

string
null

string

signingSecret

required

object

set

required

boolean

hint

required

Any of:

string
null

string

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "kind": "slack",
  "credentials": {
    "kind": "slack"
  }
}

400

ChannelInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChannelInvalid

message

required

string

Example

{
  "_tag": "ChannelInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

ChannelNotFound | ChannelIdentityNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChannelNotFound

required

string

Example

{
  "_tag": "ChannelNotFound"
}

409

ChannelConflict

application/json

object

_tag

required

string

Allowed values: ChannelConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "ChannelConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

AuthorizationUnavailable | ChannelsUnavailable | AuthenticationUnavailable

application/json

Any of:

object

_tag

required

string

Allowed values: AuthorizationUnavailable

Example

{
  "_tag": "AuthorizationUnavailable"
}