Retrieving a List of Customers | Controlata API Documentation

Returns the company's customers, sorted by name. Deleted customers are not included.

v1/customers/get_list.php

Parameters

Field	Type	Required	Description
limit	int	No	Page size, from 1 to 1000
offset	int	No	How many records to skip

Without limit the whole list is returned. See Common Rules for pagination.

Response

An array customers with the customer's fields. The total field holds the total number of customers.

Field	Type	Description
id	int	Customer ID
name	string	Name
email	string	Email
phone	string	Phone
address_legal	string	Legal address
address_real	string	Delivery address
agreement	string	Agreement
manager_name	string	Manager
manager_post	string	Manager's position
notes	string	Notes

Example request

{
    "limit": 100,
    "offset": 0
}

Example response

{
    "success": true,
    "customers": [
        {
            "id": 513,
            "name": "Anna Smith",
            "email": "anna@example.com",
            "phone": "+1 617 555-0134",
            "address_legal": "",
            "address_real": "20 Main St, Boston",
            "agreement": "",
            "manager_name": "",
            "manager_post": "",
            "notes": ""
        },
        {
            "id": 512,
            "name": "Furniture Yard",
            "email": "orders@furnitureyard.com",
            "phone": "+1 212 555-0123",
            "address_legal": "5 Forest St, New York",
            "address_real": "12 Warehouse Rd, New York",
            "agreement": "No. 15 of 10 Jan 2026",
            "manager_name": "Peter Johnson",
            "manager_post": "CEO",
            "notes": ""
        }
    ],
    "total": 2
}

Errors

Error	Reason
Invalid limit value. Must be between 1 and 1000	Invalid limit
Invalid offset value. Must be 0 or greater	Invalid offset
Offset requires limit	offset passed without limit