Sign in

v1

latestOpenAPI 3.0.02026-08-061770538.1 KB
Customer

Returns a paginated list of customers

Required permission: Customers - List/Search Single-Customer Users can only access own customer (self).

get/customers

Query parameters

sortstring

A customer field to order by. Examples "firstname ASC", "city DESC".

querystring

Search query

firstnamestring

Any customers with a first name like the parameter

lastnamestring

Any customers with a last name like the parameter

business_namestring

Any customers with a business name like the parameter

{"stackTrail":"paths:/customers:get:parameters:5:schema:items","oasType":"schema","type":"unknown"}

Any customers with ID included in the list

{"stackTrail":"paths:/customers:get:parameters:6:schema:items","oasType":"schema","type":"unknown"}

Any customers with ID not included in the list

emailstring
include_disabledstring

Whether or not the returned list of customers includes disabled customers

pageinteger

Returns provided page of results, each 'page' contains 25 results

Response

successful