Skip to main content
POST
chat.channel.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
channelId
string
required

Channel ID in your connected chat app.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
kind
enum<string>
default:group

Group conversation or public open channel.

Available options:
group,
open

Response

The result

channelId
string
required

Channel ID in your connected chat app.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
kind
enum<string>
required

Group conversation or public open channel.

Available options:
group,
open
name
string

Channel display name.

Maximum string length: 256
public
boolean

Whether users can join without an invitation.

memberCount
integer

Number of channel members, including invitees when applicable.

Required range: 0 <= x <= 9007199254740991
frozen
boolean

Whether ordinary members are prevented from sending messages.

createdAt
string<date-time>

When the channel was created, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAt
string<date-time>

When the channel was last updated, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$