Retrieve all customers
Query parameters
Filter customers by email address (case-insensitive, exact match). Accepts a single email or multiple comma-separated emails (maximum 25).
Filter by created at date/time at or after given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 00:00:00 UTC.
Filter by created at date/time at or before given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 23:59:59 UTC.
The offset value used to paginate through a list of entries. If the dir query parameter is prev then the offset will be the id of the first record of the data set otherwise the offset will be the id of the last record
An optional limit for the number of entries on a page with a maximum value of 100. Default value is 100 if not provided.
The direction to paginate the next set of data. If dir is prev the page will return a data set before the offset otherwise the data set will be after the offset. Default value is next if not provided.
Response
Successful operation. Response will return an array of 0 or more customers
Example response
{
"data": [
{
"id": 1337,
"first_name": "John",
"last_name": "Doe",
"email": "jdoe@gmail.com",
"phone": "5555555555",
"customer_tags": [
{
"name": "new"
}
],
"lifetime_value": 95025,
"updated_at": "2020-03-04 00:18:35",
"created_at": "2020-03-04 00:18:35",
"addresses": [
{
"type": "shipping",
"street": "221B Baker Street",
"postal_code": "1234",
"city": "Austin",
"state": "TX",
"region": "Quebec",
"country": "United States"
}
]
}
],
"pagination": {
"next": "https://example.samcart.com/v1/example?offset=1337&dir=next"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.