Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.crevio.co/v1/customers \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": 123,
      "email": "jsmith@example.com",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "customerType": "lead",
      "prefixId": "<string>",
      "ordersCount": 123,
      "totalSpend": 123,
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "count": 123,
    "from": 123,
    "in": 123,
    "last": 123,
    "limit": 123,
    "next": 123,
    "previous": 123,
    "offset": 123,
    "page": 123,
    "pages": 123,
    "to": 123
  }
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

customer_type
enum<string>

Filter by customer type

Available options:
lead,
free,
paid
query
string

Search by email or name

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Paginated list of customers

items
object[]
pagination
object