List customers - Clopos Open API

GET

customers

List customers

curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/customers \
  --header 'x-token: <api-key>'

const options = {method: 'GET', headers: {'x-token': '<api-key>'}};

fetch('https://integrations.clopos.com/open-api/v2/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "group_id": 123,
      "balance": {
        "id": 123,
        "amount": 123,
        "type": "<string>"
      },
      "cashback_balance": {
        "id": 123,
        "amount": 123,
        "type": "<string>"
      },
      "group": {
        "id": 123,
        "name": "<string>",
        "discount_type": "<string>",
        "discount_value": 123,
        "system_type": "<string>",
        "total_amount": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

x-token

string

header

required

JWT access token obtained from /v2/auth endpoint

Query Parameters

page

integer

default:1

Page number for pagination (1-based)

Required range: x >= 1

limit

integer

default:50

Maximum number of customers to return per page (1-999)

Required range: 1 <= x <= 999

with[]

enum<string>[]

Include related data in the response. Supported values: group

Available options:

group

filters

string[][]

Filter customers by specific fields. Use array notation: filters[0][0]=field_name&filters[0][1]=value. Supported fields: name, phones, group_id

Response

200 - application/json

Customers retrieved successfully

data

object[]

Show child attributes

pagination

object

Show child attributes

List customers

curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/customers \
  --header 'x-token: <api-key>'

const options = {method: 'GET', headers: {'x-token': '<api-key>'}};

fetch('https://integrations.clopos.com/open-api/v2/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "group_id": 123,
      "balance": {
        "id": 123,
        "amount": 123,
        "type": "<string>"
      },
      "cashback_balance": {
        "id": 123,
        "amount": 123,
        "type": "<string>"
      },
      "group": {
        "id": 123,
        "name": "<string>",
        "discount_type": "<string>",
        "discount_value": 123,
        "system_type": "<string>",
        "total_amount": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}