Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url http://localhost:3000/v2/customers/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "number": 1001,
    "name": "ABC Cleaning Services GmbH",
    "_id": "<string>",
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "contactPerson": "John Doe",
    "address": {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "<string>",
      "co": "<string>",
      "state": "<string>"
    },
    "contact": {
      "telephone": "+1-555-123-4567",
      "mobile": "+1-555-987-6543",
      "email": "[email protected]",
      "sms": "+1-555-111-2222",
      "smsCount": 5,
      "smsChatCount": 12,
      "smsSendDate": "2024-01-15T10:30:00Z",
      "smsSendBy": "user123",
      "website": "https://www.company.com",
      "lastSMSStatus": "delivered",
      "secondSmsSendDate": "2024-01-16T14:45:00Z"
    },
    "contract": {},
    "invoiceRecipientId": "<string>",
    "invoiceCCRecipientIds": [
      "<string>"
    ],
    "hideRecipientOnDocuments": false,
    "buyerReference": "04011000-1234512345-12",
    "orderReferenceId": "SUP-12345",
    "vatNumber": "DE123456789",
    "debitorNumber": "DEB-001",
    "paymentTermId": "<string>"
  }
]

Authorizations

​
x-API-Key
string
header
required

Query Parameters

​
limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
​
sort
string

Sort field and direction (e.g. number:1, status.createdAt:-1)

Example:

"number:1"

​
number
integer
​
customerHasAssignedObjectManager
string<objectid>[]
​
objectIds
string<objectid>[]

Filter by object IDs

​
nameAndAddress
string

Filter by object name or address (partial match)

​
generalField
object

A dynamic filter that allows filtering on any field with various operators. Supports string, number, boolean, date, and objectid field types.

​
status
string

Filter by status (single value or comma-separated list)

​
name
string

Filter by name (partial match, supports full name or number)

​
ids
string<objectid>[]

Filter by IDs (array of objectIds)

Response

List of customers

​
number
integer
required

Customer number (auto-generated if not provided)

Example:

1001

​
name
string
required

Customer name or company name

Example:

"ABC Cleaning Services GmbH"

​
_id
string<objectid>

Unique identifier for the customer

​
companyId
string<objectid>

The ID of the company this entity belongs to

​
status
object

Entity Status information

​
chatId
string<objectid> | null

Chat session ID for customer communications

​
contactPerson
string

Main contact person name

Example:

"John Doe"

​
address
object

Address

​
contact
object

Contact information structure containing phone numbers, email, SMS details, and website

​
contract
object

Contract information and terms

​
invoiceRecipientId
string<objectid> | null

User ID who should receive invoices

​
invoiceCCRecipientIds
string<objectid>[]

User IDs who should receive invoice copies

​
hideRecipientOnDocuments
boolean
default:false

Whether to hide recipient information on documents

​
buyerReference
string | null

XRechnung Leitweg-ID for electronic invoicing

Example:

"04011000-1234512345-12"

​
orderReferenceId
string | null

XRechnung supplier number (Lieferantennummer)

Example:

"SUP-12345"

​
vatNumber
string | null

Customer VAT number

Example:

"DE123456789"

​
debitorNumber
string | null

Custom debitor number (overwrites customer number for accounting)

Example:

"DEB-001"

​
paymentTermId
string<objectid> | null

Payment term ID that overwrites company default for invoices