Skip to content

Customers

Glossary  

Endpoint Description
GET /customers Fetch one or many customer records using filters.

GET /customers

Get a paginated set of customers. You can filter results by date or status. Use nextUrl to consume paginated results. You may also use this endpoint to lookup individual customer accounts, providing a cid parameter.

Example Request

/customers?limit=30&date_after=2022-12-31&status=active
Parameter Required? Description
cid Optional Customer ID. If included, all other parameters are ignored.
STRING
limit Optional Limit the number of results per request.
INT (default: 50)
date_before Optional Return all records prior to and including this date.
STRING (format: YYYY-MM-DD)
date_after Optional Return all records after and including this date.
STRING (format: YYYY-MM-DD)
status Optional Comma delimited list of status' to include.
Accepts: active
STRING

Response OK 200:

{
    // info about our result set
    meta: {
        limit: 50,
        pages: 20,
        results: 50,
        totalRecords: 14378,
    },
    // current page state.
    // use to consume paginated results.
    page: {
        current: 1,
        next: 2,
        prev: 1,
        prevUrl: false,
        nextUrl: "/endpoint?limit=50&page=2",
    },
    // customer data
    data: [{id: "123ABC", ...}]
}