channelLinks.getChannelLink

GET

/v1/channel-links/{code}

const url = 'https://example.com/v1/channel-links/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/channel-links/example \
  --header 'Authorization: Bearer <token>'

Shows who a link code is for, so the person can check it before they accept.

Authorizations

token
session

Parameters

Path Parameters

code

required

string

Responses

200

Success

application/json

object

channel

required

string

>= 1 characters <= 128 characters

channelName

required

string

kind

required

string

Allowed values: slack lark telegram custom

externalUserId

required

string

displayName

required

string

expiresAt

required

number

Example

{
  "kind": "slack"
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

ChannelLinkInvalid | ChannelIdentityNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChannelLinkInvalid

Example

{
  "_tag": "ChannelLinkInvalid"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}