List Customer Accounts

URL : /api/v1/customer-accounts/

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 account or related to the customer account.

Possible filters:

• code

• name

• description

• phone

• address

• email

• reference

Success Response

Code : 200 OK

Content examples :

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 811,
            "customers_count": 0,
            "code": "tc4",
            "name": "Test Customer Company 4",
            "description": "",
            "phone": "",
            "address": "",
            "email": "",
            "cognito_user_pool_id": "",
            "company": 339
        },
        ...
    ]
}