REST-API

Die clockodo-API ermöglicht die Anbindung von clockodo an andere Systeme. Rechnungs- und Projektmanagement-Anwendungen oder eigene Shell-Skripte sind Beispiele für nützliche Mash-Ups mit clockodo.

api/customers: Kunden verwalten

Objekttyp „customer“

Parameter	Typ	Beschreibung
id	integer	Die ID des Kunden
name	string	Der Name des Kunden
number	string\|null	Kundennummer
active	boolean	Ist der Kunde aktiviert?
billable_default	boolean	Abrechenbarkeit (1 oder 0)
note	string\|null	Notiz zu dem Kunden Nur für Inhaber und Manager
[projects]	array\|null	Liste aller Projekte die zu dem Kunden gehören Nur im Listenmodus, nicht bei der Abfrage eines einzelnen Kunden

Kunden auflisten

Anfrage

GET /api/customers

Antwort

{
  "customers": 
  {
    [object of type customer],
    [object of type customer], 
    ...
  }
}

Kunden abrufen

Anfrage

GET /api/customers/[ID]

Antwort

{
  "customer": [object of type customer]
}

Kunden anlegen

Anfrage

POST /api/customers

Notwendige Parameter	name

Optionale Parameter	number, active, billable_default, note

Antwort

{
  "customer": [object of type customer]
}

Kunden bearbeiten

Anfrage

PUT /api/customers/[ID]

Optionale Parameter	name, number, active, billable_default, note

Kunden deaktivieren

Anfrage

DELETE /api/customers/[ID]

Antwort

{
  "customer": [object of type customer]
}