Inquirly

Conversations Filter

POST

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

Conversations

Filter conversations with custom filter options and pagination

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//conversations/filter' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "payload": [
        {
            "attribute_key": "browser_language",
            "filter_operator": "not_eq",
            "values": [
                "en"
            ],
            "query_operator": "AND"
        },
        {
            "attribute_key": "status",
            "filter_operator": "eq",
            "values": [
                "pending"
            ],
            "query_operator": null
        }
    ]
}'

Response Example

200 - Example 1

{
    "data": {
        "meta": {
            "mine_count": 0,
            "unassigned_count": 0,
            "assigned_count": 0,
            "all_count": 0
        },
        "payload": [
            {
                "id": 0,
                "messages": [
                    {
                        "content": "string",
                        "content_type": "text",
                        "content_attributes": {},
                        "message_type": "incoming",
                        "created_at": 0,
                        "private": true,
                        "attachment": {},
                        "sender": {},
                        "conversation_id": 0
                    }
                ],
                "account_id": 0,
                "inbox_id": 0,
                "status": "open",
                "timestamp": "string",
                "contact_last_seen_at": "string",
                "agent_last_seen_at": "string",
                "unread_count": 0,
                "additional_attributes": {},
                "custom_attributes": {
                    "attribute_key": "attribute_value",
                    "priority_conversation_number": 3
                },
                "meta": {
                    "sender": {
                        "id": 0,
                        "name": "string",
                        "thumbnail": "string",
                        "channel": "string"
                    },
                    "assignee": {
                        "id": 0,
                        "uid": "string",
                        "name": "string",
                        "available_name": "string",
                        "display_name": "string",
                        "email": "string",
                        "account_id": 0,
                        "role": "agent",
                        "confirmed": true,
                        "custom_attributes": {},
                        "accounts": [
                            {
                                "id": 0,
                                "name": "string",
                                "role": "administrator"
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Request

Path Params

account_id

string

required

Query Params

page

integer

optional

Body Params application/json; charset=utf-8

payload

array [object {4}]

optional

Example:

[{"attribute_key":"browser_language","filter_operator":"not_eq","values":["en"],"query_operator":"AND"},{"attribute_key":"status","filter_operator":"eq","values":["pending"],"query_operator":null}]

attribute_key

string

optional

filter attribute name

filter_operator

enum<string>

optional

filter operator name

Allowed values:

equal_tonot_equal_tocontainsdoes_not_contain

values

array[string]

optional

array of the attribute values to filter

query_operator

enum<string>

optional

query operator name

Allowed values:

ANDOR

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

data

object

optional