Search Antavo database using customer filters

get

https://api.staging.antavo.com/customers

This endpoint allows you to search the Antavo database for customers based on specific criteria and returns the Antavo Customer ID. Note that the filtering is case-sensitive and does not support partial matches. The filtering query requires that the filter parameter has been tagged as searchable in the Antavo Management UI.

Query Params

Filtering

object

Customers can be filtered upon any configured customer field (marked as searchable). Results are case-sensitive and return exact matches.

It's possible to query multiple customers based on the last update date. Customer IDs are returned if the updated_at customer attribute is greater than a specified datetime using the format updated_at.gt=<datetime>.

string

Perform searches using key fields such as first_name, last_name, email, mobile_phone, or membership_id.

fields

string

Returns additional optional attributes from the customer object.

Note: Separating commas must be percentage encoded for API signing.

match

string

enum

Enables querying specific customer data. Currently only works with the following attributes: _id, email, and membership_id. Example usage: &match=exact&membership_id=33492206-ba75-4487-8047-a9d78a135ce9

Allowed:

limit

integer

Defaults to 100

Limits the number of events to be returned in one response. Other values are accessible by pagination made accessible via the offset.

offset

integer

Defaults to 0

Offsets the starting number of items for pagination.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful customer search

404Bad request