Skip to main content
GET
/
api
/
v1
/
conversations
List all conversations for your tenant
curl --request GET \
  --url https://api.g-tateth.com/api/v1/conversations \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "subject": "<string>",
      "status": "open",
      "priority": "low",
      "channel": "<string>",
      "customerId": "<string>",
      "assignedTo": "<string>",
      "inboxId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer sk_live_... or Bearer sk_test_...

Query Parameters

status
enum<string>

Filter by status

Available options:
open,
closed,
pending
priority
enum<string>

Filter by priority

Available options:
low,
medium,
high,
urgent
assignedTo
string

Filter by assigned user ID

inboxId
string

Filter by inbox ID

customerId
string

Filter by customer ID

page
integer
default:1

Page number

limit
integer
default:50

Items per page

Required range: x <= 100

Response

200 - application/json

List of conversations

success
boolean
data
object[]
pagination
object