Inquirly

Contact Filter

POST

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

Contacts

Filter contacts with custom filter options and pagination

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//contacts/filter' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "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
        }
    ]
}'

Response Example

200 - Example 1

[
    {
        "id": 0,
        "payload": {
            "contact": {
                "email": "string",
                "name": "string",
                "phone_number": "string",
                "thumbnail": "string",
                "additional_attributes": {},
                "custom_attributes": {
                    "attribute_key": "attribute_value",
                    "signed_up_at": "dd/mm/yyyy"
                },
                "contact_inboxes": [
                    {
                        "source_id": "string",
                        "inbox": {
                            "id": 0,
                            "name": "string",
                            "website_url": "string",
                            "channel_type": "string",
                            "avatar_url": "string",
                            "widget_color": "string",
                            "website_token": "string",
                            "enable_auto_assignment": true,
                            "web_widget_script": "string",
                            "welcome_title": "string",
                            "welcome_tagline": "string",
                            "greeting_enabled": true,
                            "greeting_message": "string"
                        }
                    }
                ]
            }
        }
    }
]

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":"name","filter_operator":"equal_to","values":["en"],"query_operator":"AND"},{"attribute_key":"country_code","filter_operator":"equal_to","values":["us"],"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

array of contacts

array of:

number

optional

payload

object

optional

contact

object

optional

🟠400Bad Request

Search Contacts

Create contact inbox