curl --request POST \
--url https://api.open.cx/chat/sessions/filter \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {},
"sort_by": "last_message_at",
"sort_order": "asc",
"page": 1,
"limit": 25
}
'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "open",
"ai_closure_type": "assumed_resolved",
"sentiment": "angry",
"channel": {
"type": "web"
},
"ticket_number": 123,
"assist_mode": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"phone_number": "<string>",
"name": "<string>",
"custom_data": {},
"non_verified_name": "<string>",
"non_verified_email": "<string>",
"non_verified_custom_data": {}
},
"language": "<string>",
"assignee_id": "<string>",
"custom_data": {},
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
},
"handoff": {
"summary": "<string>",
"sentiment": "angry"
},
"ticketing_system": {
"name": "dynamics365",
"external_id": "<string>",
"id_type": "conversation_id"
}
}
],
"page": 123,
"limit": 123,
"has_next": true,
"has_previous": true
}Search and filter chat sessions with advanced criteria. Supports filtering by date range, channels, status, sentiment, tags, assignees, teams, contacts, language, custom data, and more. Results are paginated and sortable.
curl --request POST \
--url https://api.open.cx/chat/sessions/filter \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {},
"sort_by": "last_message_at",
"sort_order": "asc",
"page": 1,
"limit": 25
}
'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "open",
"ai_closure_type": "assumed_resolved",
"sentiment": "angry",
"channel": {
"type": "web"
},
"ticket_number": 123,
"assist_mode": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"phone_number": "<string>",
"name": "<string>",
"custom_data": {},
"non_verified_name": "<string>",
"non_verified_email": "<string>",
"non_verified_custom_data": {}
},
"language": "<string>",
"assignee_id": "<string>",
"custom_data": {},
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
},
"handoff": {
"summary": "<string>",
"sentiment": "angry"
},
"ticketing_system": {
"name": "dynamics365",
"external_id": "<string>",
"id_type": "conversation_id"
}
}
],
"page": 123,
"limit": 123,
"has_next": true,
"has_previous": true
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
Sort field (default: last_message_at)
last_message_at, created_at Sort direction (default: desc)
asc, desc Page number (1-based, default: 1)
Results per page (1-100, default: 25)
Was this page helpful?