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

bot

required

string

>= 1 characters <= 128 characters

actor

required

string

enabled

required

boolean

needsAuthorization

required

boolean

linkPath

required

Any of:

string
null

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

executionId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

webhookUrl

required

string

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

ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}