Texa Desk Application API · Contacts

Contact Filter

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

Filter contacts 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

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

metaobject

meta.countinteger

Total number of contacts

meta.current_pagestring or integer

Current page number

payloadarray of object

List of contacts

payload[].additional_attributesobject

The object containing additional attributes related to the contact

payload[].additional_attributes.citystring

City of the contact

payload[].additional_attributes.countrystring

Country of the contact

payload[].additional_attributes.country_codestring

Country code of the contact

payload[].additional_attributes.created_at_ipstring

IP address when the contact was created

payload[].availability_statusstring

Availability status of the contact One of: online, offline.

payload[].emailstring

The email address of the contact

payload[].idinteger

The ID of the contact

payload[].namestring

The name of the contact

payload[].phone_numberstring

The phone number of the contact

payload[].blockedboolean

Whether the contact is blocked

payload[].identifierstring

The identifier of the contact

payload[].thumbnailstring

The thumbnail of the contact

payload[].custom_attributesobject

The custom attributes of the contact

payload[].last_activity_atinteger

Timestamp of last activity

payload[].created_atinteger

Timestamp when contact was created

payload[].contact_inboxesarray of object

List of inboxes associated with this contact

payload[].contact_inboxes[].source_idstring

Source identifier for the contact inbox

payload[].contact_inboxes[].inboxobject

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/contacts/filter' \ -H "api_access_token: $TEXA_DESK_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "payload": [ { "attribute_key": "name", "filter_operator": "equal_to", "values": [ "en" ], "query_operator": "AND" }, { "attribute_key": "country_code", "filter_operator": "equal_to", "values": [ "us" ], "query_operator": null } ] }'

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

{ "meta": { "count": 1, "current_page": "string" }, "payload": [ { "additional_attributes": { "city": "string", "country": "string", "country_code": "string", "created_at_ip": "string" }, "availability_status": "online", "email": "string", "id": 1, "name": "string", "phone_number": "string", "blocked": true, "identifier": "string", "thumbnail": "string", "custom_attributes": {}, "last_activity_at": 1, "created_at": 1, "contact_inboxes": [ { "source_id": null, "inbox": null } ] } ] }