Skip to main content
GET
Search customers

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Query Parameters

customerIds
string
default:""

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

externalCustomerId
string
default:""

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

email
string
default:""

Customer's email

phone
string
default:""

Customer's phone

status
enum<string>
default:""

Customer's status

Available options:
ACTIVE,
INACTIVE
type
enum<string>
default:""

Customer type

Available options:
INDIVIDUAL,
BUSINESS
before
string
default:""

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

after
string
default:""

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

limit
string
default:""

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

count
integer<int32>

Number of customers returned.

customers
object[]

Customers

remaining
integer<int32>

Number of remaining customers before/after this page, depending the direction this page was selected.