API ReferenceParcel Customers

List parcel customers

View as Markdown

List parcel customers for the authenticated business, newest first. Filtered by API key mode (test/live).

Use key to search by name, email, mobile, or address_suffix. Use status to filter by customer status.

Authentication

X-Api-Keystring
API Key authentication via header

Query parameters

keystringOptional

Search by name, email, mobile, or address_suffix

statusenumOptionalDefaults to active
Allowed values:
pageintegerOptionalDefaults to 1
per_pageintegerOptional<=100Defaults to 25

Response

OK
datalist of objectsOptional
metaobjectOptional

Errors

401
Unauthorized Error