DocsAPI Reference
Log In
API Reference

Search customers

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

string

Customer's email

string

Customer's phone

string
enum

Customer's status

Allowed:
string
enum

Customer type

Allowed:
string

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

string

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

int32

Limits number of returned customers.

Default value: 10 or the number of customer ids provided

Minimum value: 1

Maximum value: 100

Responses

400

Bad Request : check request values and format

401

Invalid credentials

403

Unauthenticated or authenticated with insufficient access

500

Server Error. This applies to all 5xx errors, including but not limited to 500, 501, 502, 503, and 504 errors. You should treat all of these errors the same.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*