List customers by filter
curl --request POST \
--url https://api.cloud.flexprice.io/v1/customers/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_ids": [
"<string>"
],
"email": "<string>",
"end_time": "<string>",
"expand": "<string>",
"external_id": "<string>",
"external_ids": [
"<string>"
],
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"parent_customer_ids": [
"<string>"
],
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"items": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"parent_customer": "<unknown>",
"parent_customer_id": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}Enter your API key in the format x-api-key <api-key>*
Filter
Show child attributes
string, number, date, array eq, contains, gt, lt, in, not_in, before, after 1 <= x <= 1000x >= 0asc, desc published, deleted, archived OK
Response object for listing customers with pagination
Show child attributes
AddressCity is the city of the customer's address
AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)
AddressLine1 is the first line of the customer's address
AddressLine2 is the second line of the customer's address
AddressPostalCode is the postal code of the customer's address
AddressState is the state of the customer's address
Email is the email of the customer
EnvironmentID is the environment identifier for the customer
ExternalID is the external identifier for the customer
ID is the unique identifier for the customer
Name is the name of the customer
ParentCustomerID is the parent customer identifier for the customer
published, deleted, archived curl --request POST \
--url https://api.cloud.flexprice.io/v1/customers/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_ids": [
"<string>"
],
"email": "<string>",
"end_time": "<string>",
"expand": "<string>",
"external_id": "<string>",
"external_ids": [
"<string>"
],
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"parent_customer_ids": [
"<string>"
],
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"items": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"parent_customer": "<unknown>",
"parent_customer_id": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}