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": "12345",
			"name": "Acme Corporation",
			"additional_name": null,
			"website": "www.acme-corp.com",
			"email": null,
			"phone": "+1-555-0123",
			"fax": "+1-555-0124",
			"currency": "EUR",
			"comments": "Important client - handle with care",
			"industry": "Technology",
			"vat": "19.0000",
			"tax_number": "DE123456789",
			"iban": "DE89370400440532013000",
			"bic": "COBADEFFXXX",
			"payment_target": 30,
			"payment_target_discount": 2,
			"status": {
				"id": 1,
				"name": "Active"
			},
			"created": null,
			"modified": "2024-12-15T10:30:00.000000Z",
			"billing_procedure": true,
			"automated_invoicing": true,
			"debit_payment": false,
			"department_id": 1,
			"categories": [],
			"dynamicAttributes": [],
			"addresses_count": 2,
			"managers_count": 1,
			"categories_count": 0,
			"dynamicAttributes_count": 0,
			"contacts_count": 3
		},
		{
			"customer_number": "12346",
			"name": "Global Services Ltd",
			"additional_name": "IT Division",
			"website": "www.globalservices.com",
			"email": "info@globalservices.com",
			"phone": "+44-20-7123-4567",
			"fax": null,
			"currency": "GBP",
			"comments": null,
			"industry": "Consulting",
			"vat": "20.0000",
			"tax_number": "GB123456789",
			"iban": null,
			"bic": null,
			"payment_target": 14,
			"payment_target_discount": null,
			"status": null,
			"created": null,
			"modified": "2024-11-20T14:15:00.000000Z",
			"billing_procedure": true,
			"automated_invoicing": true,
			"debit_payment": true,
			"department_id": 2,
			"categories": [
				{
					"name": "Premium Customer",
					"description": {
						"en": "Premium Customer"
					},
					"type": {
						"id": "customer",
						"name": "Customer"
					}
				}
			],
			"dynamicAttributes": [],
			"addresses_count": 1,
			"managers_count": 0,
			"categories_count": 1,
			"dynamicAttributes_count": 0,
			"contacts_count": 5
		}
	]
}

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

Customers GET Customer details