Skip to main content
GET
Get a Chat group invite link

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

The ID of the group conversation, starting with g.

Pattern: ^g[0-9]{1,19}$
token
string
required

The 10-character invite token from the group's invite link.

Pattern: ^[A-Za-z0-9_-]{10}$

Query Parameters

chat_group_invite.fields
enum<string>[]

A comma separated list of ChatGroupInvite fields to display. The fields available for a ChatGroupInvite object.

Minimum array length: 1
Available options:
conversation_id,
expires_at,
group_avatar_url,
group_name,
invite_url,
join_state,
member_count,
token,
welcome_message

Response

The request has succeeded.

data
object
errors
object[]