Lister les clients

GET

/api/customers

Retourne la liste des clients de l'organisation. Peut être filtrée par site via le header X-Site-Id ou le paramètre siteId. Utilisez includeGlobal=true pour inclure les clients organisation (siteId IS NULL) lors du filtrage par site.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Liste des clients

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/customers?siteId&page&limit&search&status&type&tags&includeGlobal' \
--header 'X-Site-Id;' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
            "firstName": "string",
            "lastName": "string",
            "email": "user@example.com",
            "phone": "string",
            "status": "ACTIVE",
            "type": "INDIVIDUAL",
            "address": {},
            "tags": [
                "string"
            ],
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0,
        "totalPages": 0
    }
}

Modified at 2026-01-04 12:06:10

Obtenir une commande par ID

Obtenir un client par ID