_search

Returns IDs of matching customers

Parameters

results-per-page (optional)

Number of results to display per page. Default is 100

current-page (optional)

Current page number. Default is 0

name (optional)

Search filter to find matching names

custom (optional)

JSON-encoded list of filters to apply against custom values

parent_id (optional)

Integer ID of a parent customer

Example

FM_api('Customers_search', [
	'results-per-page' => '10',
	'current-page' => '0',
	'name'=>'The Cafe',
	'custom'=>'{"vegan":"yes"}'
] )

On Success

{"ids":[1,2,3]}

Last updated