List Customers

URL : /api/v1/customers/

Method : GET

Query parameters

Pagination

Default pagination is 20 results per page.

• limit - Number of results to return per page.

  • Example: limit=20

• offset - The initial index from which to return the results.

  • Example: offset=21

Filtering

The results can be filtered by various attributes on customer or related to the customer.

Possible filters:

• label__in

• email

• email__icontains

• email__startswith

• company_name__icontains

• first_name__icontains

• last_name__icontains

• phone__icontains

• reference

• reference__icontains

• reference__startswith

• account

• account__name

• account__name__icontains

• account__code

• account__code__icontains

• account__description

• account__description__icontains

• account__phone

• account__phone__icontains

• account__address

• account__address__icontains

• account__email

• account__email__icontains

• account__reference

• account__reference__icontains

Success Response

Code : 200 OK

Content examples :

{
    "count": 9,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 620,
            "total_orders": 52,
            "total_licenses": 117,
            "labels": [
                {
                    "id": 3,
                    "label_id": 8,
                    "label": "Customer",
                    "color": "#ff9f43"
                },
                {
                    "id": 53,
                    "label_id": 34,
                    "label": "Loyal",
                    "color": "#3a0cd4"
                }
            ],
            "customer_account": null,
            "email": "[email protected]",
            "first_name": "Nameo",
            "last_name": "",
            "company_name": "",
            "phone": "",
            "reference": "",
            "address": "",
            "postcode": "",
            "city": "",
            "country": "",
            "state": "",
            "clabels_all": "customerloyal",
            "cognito_user_pool_id": "",
            "metadata": {},
            "company": 277,
            "license_user": 1879,
            "clabels": [
                8,
                34
            ]
        },
        ...
    ]
}