Skip to main content
GET
/
api
/
customers
/
getCustomers
curl --location 'https://api.example.com/api/customers/getCustomers?page=0&limit=10&search=acme' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "clientes": [
    {
      "customer_id": 1,
      "name": "Acme Corporation",
      "legal_name": "Acme Corp Ltd.",
      "tax_id": "ABC123456789",
      "contact_origin": "WEB_FORM",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "total_count": 1
    }
  ],
  "totalCount": 1,
  "page": 0,
  "pageSize": 10
}
Retrieve all customers from your system with support for pagination and search filtering.

​
Query Parameters

​
page
integer
default:"0"
The page number for pagination (zero-based)
​
limit
integer
default:"10"
Number of customers to return per page
​
search
string
Search term to filter customers by name or other fields

​
Response

​
success
boolean
Indicates whether the request was successful
​
clientes
array
Array of customer objects
​
totalCount
integer
Total number of customers matching the search criteria
​
page
integer
Current page number
​
pageSize
integer
Number of items per page
curl --location 'https://api.example.com/api/customers/getCustomers?page=0&limit=10&search=acme' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "clientes": [
    {
      "customer_id": 1,
      "name": "Acme Corporation",
      "legal_name": "Acme Corp Ltd.",
      "tax_id": "ABC123456789",
      "contact_origin": "WEB_FORM",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "total_count": 1
    }
  ],
  "totalCount": 1,
  "page": 0,
  "pageSize": 10
}

​
Get Customer by ID

Retrieve a specific customer by their ID.

​
Path Parameters

​
id
integer
required
The unique identifier of the customer

​
Response

​
success
boolean
Indicates whether the request was successful
​
cliente
object
The customer object with all details
curl --location 'https://api.example.com/api/customers/getCustomersById/1' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "cliente": {
    "customer_id": 1,
    "name": "Acme Corporation",
    "legal_name": "Acme Corp Ltd.",
    "tax_id": "ABC123456789",
    "contact_origin": "WEB_FORM",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us