Channel Details

This is the request for details of a channel.

GET /api/cowork/admin/teams/<teamID>/channels/<channelID>

Returns the details of the given channel, denoted by the channelID.

{
    "channelId":        "<ID of the channel>",
    "teamId":           "<ID of the team>",
    "displayName":      "<Name of the channel>",
    "description":      "A description of the channel",
    "memberGroupIds":   [ <GUID>, ... ]
    "memberUserIds":    [ <GUID>, ... ]
    "membersInherited": TRUE|FALSE
}

RESPONSE Fields	Value Type	Description
channelId	String	The GUID of the channel, used for details and further operations
teamId	String	The GUID of the team this channel is associated with
displayName	String	The display name value of the channel, as displayed in the interface
description	String	A description of the channel
memberGroupIDs	List of Strings	The list of group IDs derived from the Users and Groups manager to allow access to the channel.
memberUserIDs	List of Strings	The list of user IDs derived from the Users and Groups manager to allow access to the channel.
membersInherited	Boolean	Optional TRUE, if the channel should inherit the members of the team. Setting the `memberGroupIDs` and `memberUserIDs` has no effect. FALSE if the channel should be set up with specific memberships.

Example Request

# Request
# Use user:password for authorization
GET /api/cowork/admin/teams/3n1ytbwme7ngfyn9g9guwwurt/channels/3y8kdto0lnx3ig3mshwvrb9x7 HTTP/1.1
Accept: */*
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
{
    "channelId": "3y8kdto0lnx3ig3mshwvrb9x7",
    "teamId": "3n1ytbwme7ngfyn9g9guwwurt",
    "displayName": "Third Channel",
    "description": null,
    "memberGroupIds": [
      "sys01og8a626ajrepb47rblh0"
    ],
    "memberUserIds": [],
    "membersInherited": false
}

Channel Details

GET /api/cowork/admin/teams/<teamID>/channels/<channelID>

Example Request

{{welcome.getConfig().welcomeTitle}}

Help - /channels/<channelID>