List a customer’s contacts

Returns a paginated list of contact persons for the given customer.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/customers/{customer_number}/contacts

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers/{customer_number}/contacts' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

Name
customer_number
Type
string
Description
The customer customer number

Query parameters

Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "first_name": "Erika",
      "last_name": "Mustermann",
      "salutation": "Frau",
      "title": "Dr.",
      "phone": "+49 30 12345678",
      "mobile": "+49 170 1234567",
      "fax": "+1-555-0124",
      "email": "erika.mustermann@acme-corp.de",
      "primary": true,
      "job_title": "Leiterin Einkauf",
      "department": "Einkauf",
      "language": "de",
      "inactive": false,
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ]
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
id
Type
integer
Description
The contact’s unique identifier.
Name
first_name
Type
string
Description
The contact’s first name.
Name
last_name
Type
string
Description
The contact’s last name.
Name
salutation
Type
string, nullable
Description
The contact’s salutation (e.g. Mr./Ms.), used in correspondence.
Name
title
Type
string, nullable
Description
The contact’s academic title (e.g. Dr.).
Name
phone
Type
string, nullable
Description
The contact’s phone number.
Name
mobile
Type
string, nullable
Description
The contact’s mobile phone number.
Name
fax
Type
string, nullable
Description
The contact’s fax number.
Name
email
Type
string, nullable
Description
The contact’s e-mail address.
Name
primary
Type
boolean
Description
Whether this is the customer’s primary contact.
Name
job_title
Type
string, nullable
Description
The contact’s job title at the customer.
Name
department
Type
string, nullable
Description
Free-text department name for this contact — unrelated to the department module.
Name
language
Type
string, nullable
Description
The contact’s preferred language, used for translated content.
Name
inactive
Type
boolean
Description
Whether this contact is inactive and no longer active.
Name
categories
Type
array of Category
Description
The categories assigned to this contact. Present on GET /customers/{customer}/contacts/{contact}, POST …/contacts and PUT …/contacts/{contact}; absent on the list endpoint GET /customers/{customer}/contacts.
Name
categories.name
Type
string
Description
Name of the category, shown wherever an entity is tagged with it.
Name
categories.description
Type
object
Description
Longer explanation of what this category should be used for.
Name
categories.type
Type
object
Description
The kind of entity this category can be attached to, e.g. employee, project or customer.

Generated from the OpenAPI specification — edit the source code, not this page.

DELETE Delete a customer POST Create a customer contact