List customers

Production

https://api.simpra.app

GET

/customers

Retrieve a paginated list of customers

Request

Authorization

Add parameter in header

Simpra-Access-Token

Example:

Simpra-Access-Token: ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved customers

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.simpra.app/customers?page&per_page&only_active&updated_at' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json'

Response Example

{
    "meta": {
        "has_next_page": true,
        "current_page": 0,
        "per_page_count": 0,
        "total_count": 0,
        "total_page": 0
    },
    "customers": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "first_name": "string",
            "last_name": "string",
            "phone_number": "string",
            "email": "user@example.com",
            "gender": "male",
            "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",
            "created_at": 0,
            "updated_at": 0,
            "customer_discount_id": "19a13e6f-e7b9-4388-8c2b-b53e4048e42a",
            "account_detail": {
                "checks_count": 0,
                "checks_paid_amount": 0,
                "total_current_account": 0,
                "paid_current_account": 0,
                "remaining_current_account": 0
            },
            "tags": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string"
                }
            ],
            "external_id": "string",
            "metafields": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "key": "string",
                    "value": "string",
                    "value_type": "string",
                    "updated_at": 0
                }
            ]
        }
    ]
}

Modified at 2025-09-10 09:28:46

Add discount to check

Create customer