List conversations
curl --request GET \
--url https://public-api.staging.workchats.com/v1/conversations \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public-api.staging.workchats.com/v1/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public-api.staging.workchats.com/v1/conversations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"conversations": [
{
"id": "chn_c41a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"is_archived": false,
"is_member": true,
"is_private": true,
"member_count": 9,
"name": "sales-alerts",
"parent_id": "grp_6b0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
"topic": null,
"type": "private_channel"
}
],
"next_cursor": "<string>",
"ok": true
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}Reference
List conversations
Lists the groups and named channels the bot is a member of: the ones it can post to. Direct messages are not listed. Needs conversations:read. Limited to 20 requests a minute per installation.
GET
/
v1
/
conversations
List conversations
curl --request GET \
--url https://public-api.staging.workchats.com/v1/conversations \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public-api.staging.workchats.com/v1/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public-api.staging.workchats.com/v1/conversations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"conversations": [
{
"id": "chn_c41a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"is_archived": false,
"is_member": true,
"is_private": true,
"member_count": 9,
"name": "sales-alerts",
"parent_id": "grp_6b0a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
"topic": null,
"type": "private_channel"
}
],
"next_cursor": "<string>",
"ok": true
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}{
"error": {
"code": "token_revoked",
"message": "The token has been revoked."
},
"ok": false,
"request_id": "F7p0mJcXk3tq2x0AAAAB"
}Authorizations
Bot token (wc_bot_live_… or wc_bot_test_…) from the OAuth install
Query Parameters
Comma-separated types to include: channel, private_channel. Both by default. Unknown types, including group, are ignored.
Example:
"channel,private_channel"
Include archived groups and their channels
Page size, 200 by default. Values above 1000 are clamped.
Required range:
x >= 1The previous page's next_cursor. Omit it for the first page.