curl -X GET \
/customers \
--header "Authorization: Bearer <token>"{
"data": [
{
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
},
"defaultInvoiceAddress": {
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
},
"defaultEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultPaymentMethod": {},
"isPartner": true,
"parentCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Klinik Musterstadt"
},
"childrenCount": 3,
"isParent": true,
"isChild": true
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Get customers
Required permissions:customer:readcurl -X GET \
/customers \
--header "Authorization: Bearer <token>"{
"data": [
{
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
},
"defaultInvoiceAddress": {
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
},
"defaultEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultInvoiceEmailAddress": {
"email": "john.doe@example.com",
"receiverName": "John Doe",
"type": "TYPE_COMPANY",
"id": "00000000-0000-0000-0000-000000000000",
"default": "true"
},
"defaultPaymentMethod": {},
"isPartner": true,
"parentCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Klinik Musterstadt"
},
"childrenCount": 3,
"isParent": true,
"isChild": true
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The collection page number
The number of items per page
0 <= x <= 100Filter by parent customer ID. Returns only direct children of the specified parent.
Filter customers that have child customers (true) or do not have child customers (false).
Filter customers that have a parent customer (true) or are root-level customers (false).
War diese Seite hilfreich?