Get All Customers
You can use this endpoint to call up a paginated list of all customers.
Request
GET /api/v1/customers
curl --request GET \
--url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'Response
{
"data": [
{
"customer_number": "18512",
"name": "Runte, Mayert and Maggio",
"additional_name": null,
"website": null,
"email": "jacey.bailey@example.com",
"phone": null,
"fax": null,
"currency": "USD",
"comments": "Natus ad neque ut consequatur nam.",
"industry": "ccfa",
"tax": "0.0000",
"tax_number": null,
"iban": null,
"bic": null,
"payment_target": 60,
"payment_target_discount": 0,
"status": 0,
"created": "2024-03-25T11:10:41.000000Z",
"modified": "2024-03-25T11:10:41.000000Z",
"billing_procedure": 1,
"automated_invoicing": null,
"debit_payment": null,
"addresses_count": 1,
"managers_count": 1,
"categories_count": 1,
"dynamicAttributes_count": 1,
"contacts_count": 1
},
{
"customer_number": "49187",
// ...
}
]
}Optional Parameters
- Name
start_date- Type
- date | Y-m-d
- Description
First day of the period to be queried. It is inclusive, so the day specified as start_date will also be considered on the results
- Name
end_date- Type
- date | Y-m-d
- Description
Last day of the period to be queried. It is inclusive, so the day specified as end_date will also be considered on the results.
- Name
customer_number | customer_number[]- Type
- string | array of strings
- Description
A single customer number or a list of customer numbers to filter the results.
- Name
limit- Type
- integer
- Description
Attribute for limiting the number of entries per page