---
title: "List"
method: GET
path: "/customers/"
---

# List

`GET /customers/`

## Request

- Base URL: `https://restapi.ordergroove.com`
- URL: `https://restapi.ordergroove.com/customers/`
- Auth: one of:
  - none
  - API key in header `x-api-key`

This request will return an array of all customers.

## Query parameters

- `live` string
- `email` string
- `updated` string, date
- `updated_start` string, date
- `updated_end` string, date
- `created` string, date
- `created_start` string, date
- `created_end` string, date

## Response `200`

200

- object
  - `merchant` string
  - `merchant_user_id` string
  - `session_id` string
  - `user_token_id` string
  - `first_name` string
  - `last_name` string
  - `email` string
  - `phone_number` string
  - `phone_type` integer
  - `live` boolean
  - `created` string
  - `last_updated` string
  - `last_login` unknown
  - `extra_data` unknown
  - `locale` integer

## Other responses

- `403`: 403
- `404`: 404

---

[API](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc.md) - [All operations](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/llms.txt) - [OpenAPI document](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/revisions/ba97e740d08c?raw)