Texa Desk Application API · Conversations

Conversations Filter

POST/api/v1/accounts/{account_id}/conversations/filter

Filter conversations with custom filter options and pagination

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The numeric ID of the account

Query parameters

pagenumber

sort_bystring

Sort filtered conversations using the same options as the conversation list.

Body application/json

payloadarray of object

payload[].attribute_keystring

filter attribute name

payload[].filter_operatorstring

filter operator name One of: equal_to, not_equal_to, contains, does_not_contain.

payload[].valuesarray of string

array of the attribute values to filter

payload[].query_operatorstring

query operator name One of: AND, OR.

Responses

200

Success

dataobject

data.metaobject

data.meta.mine_countnumber

data.meta.unassigned_countnumber

data.meta.assigned_countnumber

data.meta.all_countnumber

data.payloadarray of object

array of conversations

data.payload[].idnumber

ID of the conversation

data.payload[].messagesarray of object

data.payload[].account_idnumber

Account Id

data.payload[].uuidstring

UUID of the conversation

data.payload[].additional_attributesobject

The object containing additional attributes related to the conversation

data.payload[].agent_last_seen_atnumber

The last activity at of the agent

data.payload[].assignee_last_seen_atnumber

The last activity at of the assignee

data.payload[].can_replyboolean

Whether the conversation can be replied to

data.payload[].contact_last_seen_atnumber

The last activity at of the contact

data.payload[].custom_attributesobject

The object to save custom attributes for conversation, accepts custom attributes key and value

data.payload[].inbox_idnumber

ID of the inbox

data.payload[].labelsarray of string

The labels of the conversation

data.payload[].mutedboolean

Whether the conversation is muted

data.payload[].snoozed_untilnumber

The time at which the conversation will be unmuted

data.payload[].statusstring

The status of the conversation One of: open, resolved, pending.

data.payload[].created_atnumber

The time at which conversation was created

data.payload[].updated_atnumber

The time at which conversation was updated

data.payload[].timestampnumber

The time at which conversation was created

data.payload[].first_reply_created_atnumber

The time at which the first reply was created

data.payload[].unread_countnumber

The number of unread messages

data.payload[].last_non_activity_messageobject or null

The last non activity message

data.payload[].last_activity_atnumber

The last activity at of the conversation

data.payload[].prioritystring

The priority of the conversation

data.payload[].waiting_sincenumber

The time at which the conversation was waiting

data.payload[].sla_policy_idnumber

The ID of the SLA policy

data.payload[].applied_slaobject

The applied SLA

data.payload[].sla_eventsarray of object

data.payload[].metaobject

400

Bad Request Error

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X POST 'https://desk.texadesk.com/api/v1/accounts/1/conversations/filter' \ -H "api_access_token: $TEXA_DESK_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "payload": [ { "attribute_key": "browser_language", "filter_operator": "not_equal_to", "values": [ "en" ], "query_operator": "AND" }, { "attribute_key": "status", "filter_operator": "equal_to", "values": [ "pending" ], "query_operator": null } ] }'

import os, requests headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]} body = { "payload": [ { "attribute_key": "browser_language", "filter_operator": "not_equal_to", "values": [ "en" ], "query_operator": "AND" }, { "attribute_key": "status", "filter_operator": "equal_to", "values": [ "pending" ], "query_operator": None } ] } r = requests.post("https://desk.texadesk.com/api/v1/accounts/1/conversations/filter", headers=headers, json=body) r.raise_for_status() print(r.json())

{ "data": { "meta": { "mine_count": 1.0, "unassigned_count": 1.0, "assigned_count": 1.0, "all_count": 1.0 }, "payload": [ { "id": 1.0, "messages": [ null ], "account_id": 1.0, "uuid": "string", "additional_attributes": {}, "agent_last_seen_at": 1.0, "assignee_last_seen_at": 1.0, "can_reply": true, "contact_last_seen_at": 1.0, "custom_attributes": {}, "inbox_id": 1.0, "labels": [ null ], "muted": true, "snoozed_until": 1.0, "status": "open", "created_at": 1.0, "updated_at": 1.0, "timestamp": 1.0, "first_reply_created_at": 1.0, "unread_count": 1.0, "last_non_activity_message": null, "last_activity_at": 1.0, "priority": "string", "waiting_since": 1.0, "sla_policy_id": 1.0, "applied_sla": {}, "sla_events": [ null ], "meta": { "sender": null, "channel": null, "assignee": null, "hmac_verified": null } } ] } }