Kustomer

Kustomer integration (Productivity, Data). Imported from open-connector.

API key8 toolshttps://api.kustomerapp.com/v1

GET

kustomer_list_customers

List Kustomer customers with pagination, sorting, and createdAt or updatedAt timestamp filters.

/customers

4 parameters

Param	Type	Required	Description
filter	object	optional	Kustomer customer list filters for createdAt and updatedAt timestamp ranges.
sort	string	optional	Sort customers by createdAt or updatedAt, with '-' for descending order.
page	integer	optional	Page number of customer results to return.
pageSize	integer	optional	Number of customer results to return per page.

GET

kustomer_get_customer

Retrieve one Kustomer customer by customer ID.

/customers/{id}

2 parameters

Param	Type	Required	Description
id	string	required	Kustomer customer ID. A comma-separated list can retrieve multiple customers.
include	string	optional	Comma-separated includes. Kustomer documents company as the supported include f…

GET

kustomer_get_customer_by_email

Retrieve one Kustomer customer by email address.

2 parameters

Param	Type	Required	Description
email	string	required	Customer email address.
include	string	optional	Comma-separated includes. Kustomer documents company as the supported include f…

GET

kustomer_get_customer_by_external_id

Retrieve one Kustomer customer by external ID.

2 parameters

Param	Type	Required	Description
externalId	string	required	External customer ID from another system.
include	string	optional	Comma-separated includes. Kustomer documents company as the supported include f…

GET

kustomer_get_customer_by_phone

Retrieve one Kustomer customer by phone number.

2 parameters

Param	Type	Required	Description
phone	string	required	Customer phone number.
include	string	optional	Comma-separated includes. Kustomer documents company as the supported include f…

POST

kustomer_search_customers

Search Kustomer customers with Kustomer's JSON search criteria DSL.

/customers/search

7 parameters

Param	Type	Required	Description
query	object	required	Kustomer customer search criteria JSON body.
page	integer	optional	Page number of search results to return.
pageSize	integer	optional	Number of search results to return per page.
idsOnly	boolean	optional	Return only matching customer IDs.
id	string	optional	Saved search ID used to execute a stored query before searching.
withIntelliAggs	boolean	optional	Include intelligent aggregation data in search results.
trackTotalHits	boolean	optional	Track an exact total hit count for the search request.

POST

kustomer_create_customer

Create a Kustomer customer with common identity, contact, tag, and custom attribute fields.

/customers

1 parameter

Param	Type	Required	Description
customer	object	optional	Kustomer customer attributes accepted by create and update customer endpoints.

PUT

kustomer_update_customer

Update a Kustomer customer with common identity, contact, tag, and custom attribute fields.

/customers/{id}

3 parameters

Param	Type	Required	Description
id	string	required	Kustomer customer ID.
replace	boolean	optional	If true, replace the full resource instead of applying merge semantics.
customer	object	required	Kustomer customer attributes accepted by create and update customer endpoints.