Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Customer

List customers

Fetches a list of customers based on provided filters and pagination parameters. This endpoint supports filtering by various customer attributes, as well as cursor and page-based pagination for efficient data retrieval.

get/api/v2/customers

Query parameters

key'id' | 'uuid' | 'number' | 'customerType' | 'name' | 'deviatingCustomerNumber' | 'firstname' | 'lastname' | 'title' | 'salutation' | 'birthdate' | 'department' | 'subDepartment' | 'projectId' | 'phone' | 'fax' | 'email' | 'website' | 'salesManager' | 'accountManager' | 'isLead' | 'contactPerson' | 'street' | 'zip' | 'city' | 'state' | 'addressType'
op'equals' | 'notEquals' | 'lessThan' | 'greaterThan' | 'in' | 'notIn'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

Page-based pagination (Default). Use this or cursor, but not both. If both are provided, an exception will be thrown.

nextCursorstring

nextCursor should be base64 encoded string returned from api

sizestring

Page size should usually be an integer between 10 and 50.

Cursor-based pagination. Use this or page, but not both. If both are provided, an exception will be thrown.

field'id'
dir'asc' | 'desc'

Response

List of contact persons

Example response

{
  "data": [
    {
      "id": "17",
      "uuid": "a00fd11e-3a67-433b-83c0-4e815fd4a0e1",
      "number": "700001",
      "deviatingCustomerNumber": "711223",
      "customerType": "person",
      "name": "Sample Company ltd.",
      "firstname": "Max",
      "lastname": "Mustermann",
      "title": "Prof. Dr.",
      "salutation": "mr",
      "birthdate": "1970-01-01",
      "department": "Sales",
      "subDepartment": "Online Sales",
      "projects": [
        {
          "id": "1337"
        },
        {
          "id": "1336"
        }
      ],
      "contactDetails": {
        "phone": "+49 123 4567890",
        "fax": "+49 123 4567890-1",
        "email": "name@provider.com",
        "website": "http://my.website.tld",
        "additionalData": [
          {
            "label": "Skype",
            "value": "max.mustermann"
          }
        ]
      },
      "accountManager": {
        "id": "321"
      },
      "salesManager": {
        "id": "245"
      },
      "isLead": true,
      "contactPerson": "Milo Thatch",
      "documentDelivery": {
        "offer": {
          "email": "offer-send@domain.tpl",
          "cc": "offer-send-cc@otherdomain.tpl"
        },
        "salesOrder": {
          "email": "salesOrder-send@domain.tpl",
          "cc": "salesOrder-send-cc@otherdomain.tpl"
        },
        "invoice": {
          "email": "invoice-send@domain.tpl",
          "cc": "invoice-send-cc@otherdomain.tpl"
        },
        "creditNote": {
          "email": "creditNote-send@domain.tpl",
          "cc": "creditNote-send-cc@otherdomain.tpl"
        },
        "deliveryNote": {
          "email": "deliveryNote-send@domain.tpl",
          "cc": "deliveryNote-send-cc@otherdomain.tpl"
        },
        "purchaseOrder": {
          "email": "purchaseOrder-send@domain.tpl",
          "cc": "purchaseOrder-send-cc@otherdomain.tpl"
        },
        "dunning": {
          "email": "dunning-send@domain.tpl",
          "cc": "dunning-send-cc@otherdomain.tpl"
        }
      }
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}