List conversations
Conversations of an Inbox by status: new, open, waiting or closed. Administrators and Team Managers only.
GET https://cotlet.dev/api/v1/gladly/conversations
read
Reads the status tab of the Gladly home page. New means no Agent has the Conversation yet; Open has an Agent and an open Contact; Waiting is a replied email or an ended call or chat that was not closed; Closed is closed by an Agent. Only Administrators and Team Managers see these tabs, so other roles get APP_PERMISSION_DENIED. Pass conversation_id to get_conversation.
Parameters
| Name | Type | Description |
|---|---|---|
| status enum required | enum | new, open, waiting or closed. |
| inbox_id string | string | Inbox ID from list_assignees. Default: all Inboxes you can see. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl "https://cotlet.dev/api/v1/gladly/conversations?status=new" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("gladly", "list_conversations", {"status":"new"})const result = await cotlet.call('gladly', 'list_conversations', {"status":"new"});cotlet call gladly list_conversations --data '{"status":"new"}'Example response
{
"conversations": [
{
"conversation_id": "HXRqKC5GSV-jAlq0-sxYTA",
"customer_id": "o2sg-TMTSD2rTwMuxzewbA",
"customer": "Marco Silva",
"channel": "email",
"status": "new",
"inbox": "Email Inbox",
"preview": "Where is my parcel? I ordered on the 9th."
},
{
"conversation_id": "ZbT9m2QxR7iKd4WnHq0LpA",
"customer_id": "gHufx-U3QqOmhvFuViceTw",
"customer": "Dana Reyes",
"channel": "email",
"status": "new",
"inbox": "Email Inbox",
"preview": "I want a refund and a different size."
}
],
"next_cursor": null
}