v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB
Customers

Search customers

Returns a list of customers that match the query parameters. The customers are sorted by external id.

get/accounts/customers

Query parameters

customerIdsstring

Meld generated unique identifier for your customer. This should be used to track customer activity. This takes a comma separated list of customer ids.

externalCustomerIdstring

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

emailstring

Customer's email

phonestring

Customer's phone

status'ACTIVE' | 'INACTIVE'

Customer's status

type'INDIVIDUAL' | 'BUSINESS'

Customer type

beforestring

Key of customer to get before. The next batch of results will be immediately before this customer.

afterstring

Key of customer to get after. The next batch of results will be immediately after this customer.

limitstring

Limits number of returned customers.

Default value: 10 or the number of customer ids provided

Minimum value: 1

Maximum value: 100

Response

Customers are returned