List accessible inbox conversations with existing folder and status filters
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"channel": "playground",
"subject": "<string>",
"ticketNumber": 0,
"mode": "ai",
"createdAt": "2023-11-07T05:31:56Z",
"lastMessageAt": "2023-11-07T05:31:56Z",
"contactId": "<string>",
"createdBy": "<string>",
"messageCount": 4503599627370495,
"preview": "<string>",
"lastMessageRole": "<string>",
"inboxStatus": "open",
"assigneeId": "<string>",
"teamId": "<string>",
"priority": "<string>",
"dueAt": "2023-11-07T05:31:56Z",
"unseenCount": 4503599627370495,
"awaitingTeammate": true,
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
]
}
]Inbox
List accessible inbox conversations with existing folder and status filters
Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
GET
/
workspaces
/
{workspaceId}
/
inbox
List accessible inbox conversations with existing folder and status filters
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"channel": "playground",
"subject": "<string>",
"ticketNumber": 0,
"mode": "ai",
"createdAt": "2023-11-07T05:31:56Z",
"lastMessageAt": "2023-11-07T05:31:56Z",
"contactId": "<string>",
"createdBy": "<string>",
"messageCount": 4503599627370495,
"preview": "<string>",
"lastMessageRole": "<string>",
"inboxStatus": "open",
"assigneeId": "<string>",
"teamId": "<string>",
"priority": "<string>",
"dueAt": "2023-11-07T05:31:56Z",
"unseenCount": 4503599627370495,
"awaitingTeammate": true,
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
]
}
]Authorizations
accountBeareraccountSessionlocalAccountSession
Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.
Path Parameters
Minimum string length:
1Query Parameters
Available options:
open, snoozed, closed, spam Available options:
mentions, spam, team, created-by-you, unseen Minimum string length:
1Minimum string length:
1Allowed value:
"1"Response
List accessible inbox conversations with existing folder and status filters
Minimum string length:
1Minimum string length:
1Available options:
playground, widget, api, email, dashboard Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
ai, human 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Minimum string length:
1Minimum string length:
1Required range:
0 <= x <= 9007199254740991Available options:
open, snoozed, closed, spam Minimum string length:
1Minimum string length:
1Pattern:
^(?:(?:\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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes