API-Referenz

Erste Schritte

Für den Einstieg in die API empfehlen wir ein Tool zum Testen von APIs. Bruno und Postman eignen sich beide hervorragend, um API-Anfragen auszuprobieren und Ihren Ablauf abzustimmen, bevor Sie mit dem Programmieren beginnen.

Erste Schritte mit Bruno

Zunächst müssen Sie Bruno herunterladen und installieren. Bruno ist ein hervorragendes Open-Source-Tool, um API-Anfragen auszuprobieren und Ihren Ablauf abzustimmen, bevor Sie mit dem Programmieren beginnen.

Sammlung in Bruno importieren — Importieren Sie unsere Bruno-Sammlung, indem Sie diese Datei herunterladen. So erhalten Sie alle unsere Endpunkte und Parameter.

So fügen Sie den API-Schlüssel in Bruno hinzu — Die Authentifizierung erfolgt per API-Schlüssel über den Anfrage-Header "apiKey".

Erste Schritte mit Postman

Zunächst müssen Sie Postman herunterladen und installieren. Postman ist ein hervorragendes Tool, um API-Anfragen auszuprobieren und Ihren Ablauf abzustimmen, bevor Sie mit dem Programmieren beginnen.

Sammlung in Postman importieren — Importieren Sie unsere Postman-Sammlung, indem Sie diesen Link kopieren. So erhalten Sie alle unsere Endpunkte und Parameter.

So fügen Sie den API-Schlüssel in Postman hinzu — Die Authentifizierung erfolgt per API-Schlüssel über den Anfrage-Header "apiKey".

Referenz

Gruppen abrufen

Gibt Informationen zu den Gruppenobjekten zurück. Liefert alle Gruppen.

Beispielabfrage

GET https://timeclock.kiwi/api/groups

Beispielantwort

`1`	`[`
`2`	`{`
`3`	`"id": "d2358de1-3631-428a-a314-f1bdb8ab53a2",`
`4`	`"name": "Auckland",`
`5`	`"deleted": false,`
`6`	`"last_updated": "2024-06-06T21:19:17.622Z",`
`7`	`"created": "2024-06-06T21:19:17.622Z"`
`8`	`},`
`9`	`{`
`10`	`"id": "369b6e85-b90f-4262-9fab-08da623fe3bd",`
`11`	`"name": "Christchurch",`
`12`	`"deleted": false,`
`13`	`"last_updated": "2024-08-12T20:00:36.701Z",`
`14`	`"created": "2024-08-12T20:00:36.701Z"`
`15`	`}`
`16`	`]`

Aufträge abrufen

Gibt Informationen zu den Auftragsobjekten zurück. Liefert standardmäßig alle Aufträge.

Parameters

Property	Description	Type	Requirement	Default
id	Mit einer ID wird genau dieser Auftrag zurückgegeben. Ohne diesen Wert werden alle Aufträge zurückgegeben.	UUID	Optional
completed	Gibt nur Aufträge zurück, deren Feld completed dem Wert entspricht.	Boolean	Optional	false
deleted	Gibt nur Aufträge zurück, deren Feld deleted dem Wert entspricht.	Boolean	Optional	false

Example Query

GET https://timeclock.kiwi/api/jobs?id=01d2aa95-1866-4718-8d86-08aa5182f20d&completed=true&deleted=true

Beispielantwort

[
    {
        "id": "055fdff9-c264-4c5d-a98e-e98bab581d1a",
        "name": "63 Handover Rd",
        "description": "",
        "cost_code": null,
        "due_date": null,
        "completed": false,
        "permanent": false,
        "deleted": false,
        "budget_hours": 120,
        "priority": false,
        "last_updated": "2024-11-01T02:22:56.973Z",
        "created": "2024-11-01T02:22:56.973Z",
        "groups": [
            {
                "id": "f8a97df7-85b9-4331-a284-9463c68810b8",
                "name": "Mosgiel"
            }
        ],
        "people": null
    },
]

Auftrag hinzufügen

Fügt ein Auftragsobjekt hinzu.

Body

Property	Description	Type	Requirement	Default
name	Der Name des Auftrags.	String	Required
description	Die Beschreibung des Auftrags.	String	Optional
permanent	Kann dieser Auftrag als abgeschlossen markiert werden?	Boolean	Optional	false
due_date	Das Datum, bis zu dem der Auftrag abgeschlossen sein muss.	String	Erforderlich, wenn permanent == false
cost_code	Die Kostenstelle des Auftrags.	String	Optional
completed	Wurde dieser Auftrag abgeschlossen?	Boolean	Optional	false
deleted	Wurde dieser Auftrag gelöscht?	Boolean	Optional	false
budget_hours	Die für den Auftrag budgetierten (angebotenen) Arbeitsstunden. null für kein Budget.	Number	Optional	null
priority	Ist dies ein Prioritätsauftrag? Prioritätsaufträge erscheinen am Kiosk zuerst.	Boolean	Optional	false

Example Query

POST https://timeclock.kiwi/api/jobs

{
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": false,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "budget_hours": 120,
    "priority": false,
    "completed": false,
    "deleted": false
}

Beispielantwort

{
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": false,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "budget_hours": 120,
    "priority": false,
    "completed": false,
    "deleted": false,
    "id": "b6dac400-5097-4763-8021-137222cb1ad4"
}

Aufträge löschen

Löscht die aufgeführten Auftragsobjekte.

Body

Eigenschaft	Beschreibung	Typ	Pflicht	Standard
UUID	Eine Liste der UUIDs aller zu löschenden Aufträge.	UUID	Pflicht

Example Query

DELETE https://timeclock.kiwi/api/jobs

`1`	`["01d2aa95-1866-4718-8d86-08aa5182f20d", "13074d81-2483-46ea-8bce-b8d761c2580e"]`

Beispielantwort

`1`	`{`
`2`	`"status": 200`
`3`	`}`

Auftrag aktualisieren

Aktualisiert ein Auftragsobjekt.

Body

Eigenschaft	Beschreibung	Typ	Pflicht	Standard
id	Die UUID des Auftrags, den Sie ändern möchten.	UUID	Pflicht
name	Der Name des Auftrags.	String	Pflicht
description	Die Beschreibung des Auftrags.	String	Optional
permanent	Kann dieser Auftrag als abgeschlossen markiert werden?	Boolean	Optional	false
due_date	Das Datum, bis zu dem der Auftrag abgeschlossen sein soll.	String	Pflicht, wenn permanent == false
cost_code	Die Kostenstelle des Auftrags.	String	Optional
completed	Wurde dieser Auftrag abgeschlossen?	Boolean	Optional	false
deleted	Wurde dieser Auftrag gelöscht?	Boolean	Optional	false
budget_hours	Die für den Auftrag budgetierten (angebotenen) Arbeitsstunden. null für kein Budget.	Number	Optional	null
priority	Ist dies ein Prioritätsauftrag? Prioritätsaufträge erscheinen am Kiosk zuerst.	Boolean	Optional	false
groups	Die UUIDs aller Gruppen, zu denen dieser Auftrag gehört.	UUID	Optional
people	Die UUIDs aller Personen, für die dieser Auftrag sichtbar ist.	UUID	Optional
materials	Eine Liste aller Materialien, die bei diesem Auftrag verwendet wurden. Materialien müssen von einer Person verwendet worden sein.	UUID	Optional
notes	Fügt dem Auftrag eine neue Notiz hinzu.	UUID	Optional

Example Query

PUT https://timeclock.kiwi/api/jobs

{
    "id": "dfb37a1e-692e-44d5-bedf-309b44b9e136",
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": true,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "completed": true,
    "deleted": true,
    "groups": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],
    "people": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],
    "materials": [{ "id": "03b133a9-4546-4e73-89c8-119fb5042fdb", "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "quantity": 5}],
    "notes": [{ "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "note": "Concrete has cat paw prints on it."}]
}

Beispielantwort

`1`	`{`
`2`	`"status": 200`
`3`	`}`

Terminals abrufen

Gibt Informationen zu den Terminalobjekten zurück. Liefert alle Terminals.

Beispielabfrage

GET https://timeclock.kiwi/api/kiosks

Beispielantwort

`1`	`[`
`2`	`{`
`3`	`"id": "353e1f09-9851-42c8-9b2c-e536ce2cd3bb",`
`4`	`"name": "Back Stairs",`
`5`	`"deleted": false,`
`6`	`"status": "Offline",`
`7`	`"last_updated": "2024-06-10T00:09:43.169Z",`
`8`	`"created": "2024-06-10T00:09:43.169Z"`
`9`	`},`
`10`	`{`
`11`	`"id": "7276d2e1-0fe2-4b64-8d89-1e9b65f4a969",`
`12`	`"name": "Factory Front",`
`13`	`"deleted": false,`
`14`	`"status": "Offline",`
`15`	`"last_updated": "2024-06-10T02:22:51.027Z",`
`16`	`"created": "2024-06-10T02:22:51.027Z"`
`17`	`}`
`18`	`]`

Materialien abrufen

Gibt Informationen zu den Materialobjekten zurück. Liefert alle Materialien.

Beispielabfrage

GET https://timeclock.kiwi/api/materials

Beispielantwort

`1`	`[`
`2`	`{`
`3`	`"id": "03b133a9-4546-4e73-89c8-119fb5042fdb",`
`4`	`"name": "M2 Screw",`
`5`	`"cost_code": "0001",`
`6`	`"unit": "none",`
`7`	`"description": "2mm thick screw",`
`8`	`"last_updated": "2024-08-19T21:42:33.021Z",`
`9`	`"created": "2024-08-19T21:42:33.021Z"`
`10`	`},`
`11`	`{`
`12`	`"id": "c127106f-0570-485c-9466-dcf543d9ffbd",`
`13`	`"name": "MDF18",`
`14`	`"cost_code": "ABC123",`
`15`	`"unit": "m²",`
`16`	`"description": "18mm MDF",`
`17`	`"last_updated": "2024-08-05T03:08:12.870Z",`
`18`	`"created": "2024-08-05T03:08:12.870Z"`
`19`	`}`
`20`	`]`

Personen abrufen

Gibt Informationen zu den Personenobjekten zurück. Liefert alle Personen.

Beispielabfrage

GET https://timeclock.kiwi/api/people

Beispielantwort

[
    {
        "id": "b6cc9e4b-cccb-4206-92a0-a387ff121c69",
        "first_name": "Aspen",
        "last_name": "Brewster",
        "email": "[email protected]",
        "pin_enabled": false,
        "pin": null,
        "permission": 3,
        "last_updated": "2024-09-09T02:44:06.604Z",
        "created": "2024-09-09T02:44:06.604Z"
    },
    {
        "id": "2d68300b-f34e-45f9-a1a5-fdf0daa59729",
        "first_name": "Bryne",
        "last_name": "Lynton",
        "email": null,
        "pin_enabled": false,
        "pin": null,
        "permission": 3,
        "last_updated": "2024-09-09T02:44:06.604Z",
        "created": "2024-09-09T02:44:06.604Z"
    }
]

Schichten abrufen

Gibt Informationen zu den Schichtobjekten zurück.

Parameter

Eigenschaft	Beschreibung	Typ	Pflicht
start-date	Erster Tag der zurückzugebenden Schichten (einschließlich).	ISO-8601-Datum (YYYY-MM-DD)	Pflicht
end-date	Letzter Tag der zurückzugebenden Schichten (einschließlich).	ISO-8601-Datum (YYYY-MM-DD)	Pflicht
group-id	Gibt nur Schichten von Personen zurück, die zu dieser Gruppe gehören.	UUID	Optional
person-id	Gibt nur Schichten dieser Person zurück.	UUID	Optional

Example Query

GET https://timeclock.kiwi/api/shifts?start-date=2026-02-20&end-date=2026-02-27&group-id=752d68b5-5d57-4727-8c1c-85383b76fecf&person-id=a8b3e429-d307-4cd1-bde4-1c2510b6b8ef

Beispielantwort

[
  {
    "person_id": "a8b3e429-d307-4cg1-bde4-1c2510b8b8ef",
    "first_name": "Ada",
    "last_name": "Nicodemou",
    "days": [
      {
        "date": "2026-02-20",
        "total_hours": 6.82,
        "hours_worked": 6.57,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-21",
        "total_hours": 6.98,
        "hours_worked": 6.73,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-22",
        "total_hours": 7.02,
        "hours_worked": 6.77,
        "break_hours": 0.25
      }
    ]
  },
  {
    "person_id": "b1d8859f-84cc-49c0-ba94-175c8a1e16c4",
    "first_name": "Fred",
    "last_name": "Flinstone",
    "days": [
      {
        "date": "2026-02-20",
        "total_hours": 8.12,
        "hours_worked": 7.95,
        "break_hours": 0.17
      },
      {
        "date": "2026-02-21",
        "total_hours": 8.13,
        "hours_worked": 7.88,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-22",
        "total_hours": 1.97,
        "hours_worked": 1.72,
        "break_hours": 0.25
      }
    ]
  }
]

`1`	`[`
`2`	`{`
`3`	`"person_id": "a8b3e429-d307-4cg1-bde4-1c2510b8b8ef",`
`4`	`"first_name": "Ada",`
`5`	`"last_name": "Nicodemou",`
`6`	`"days": [`
`7`	`{`
`8`	`"date": "2026-02-20",`
`9`	`"total_hours": 6.82,`
`10`	`"hours_worked": 6.57,`
`11`	`"break_hours": 0.25`
`12`	`},`
`13`	`{`
`14`	`"date": "2026-02-21",`
`15`	`"total_hours": 6.98,`
`16`	`"hours_worked": 6.73,`
`17`	`"break_hours": 0.25`
`18`	`},`
`19`	`{`
`20`	`"date": "2026-02-22",`
`21`	`"total_hours": 7.02,`
`22`	`"hours_worked": 6.77,`
`23`	`"break_hours": 0.25`
`24`	`}`
`25`	`]`
`26`	`},`
`27`	`{`
`28`	`"person_id": "b1d8859f-84cc-49c0-ba94-175c8a1e16c4",`
`29`	`"first_name": "Fred",`
`30`	`"last_name": "Flinstone",`
`31`	`"days": [`
`32`	`{`
`33`	`"date": "2026-02-20",`
`34`	`"total_hours": 8.12,`
`35`	`"hours_worked": 7.95,`
`36`	`"break_hours": 0.17`
`37`	`},`
`38`	`{`
`39`	`"date": "2026-02-21",`
`40`	`"total_hours": 8.13,`
`41`	`"hours_worked": 7.88,`
`42`	`"break_hours": 0.25`
`43`	`},`
`44`	`{`
`45`	`"date": "2026-02-22",`
`46`	`"total_hours": 1.97,`
`47`	`"hours_worked": 1.72,`
`48`	`"break_hours": 0.25`
`49`	`}`
`50`	`]`
`51`	`}`
`52`	`]`

`1`	`[`
`2`	`{`
`3`	`"id": "055fdff9-c264-4c5d-a98e-e98bab581d1a",`
`4`	`"name": "63 Handover Rd",`
`5`	`"description": "",`
`6`	`"cost_code": null,`
`7`	`"due_date": null,`
`8`	`"completed": false,`
`9`	`"permanent": false,`
`10`	`"deleted": false,`
`11`	`"budget_hours": 120,`
`12`	`"priority": false,`
`13`	`"last_updated": "2024-11-01T02:22:56.973Z",`
`14`	`"created": "2024-11-01T02:22:56.973Z",`
`15`	`"groups": [`
`16`	`{`
`17`	`"id": "f8a97df7-85b9-4331-a284-9463c68810b8",`
`18`	`"name": "Mosgiel"`
`19`	`}`
`20`	`],`
`21`	`"people": null`
`22`	`},`
`23`	`]`

`1`	`{`
`2`	`"name": "99 Bamford St",`
`3`	`"description": "Renovating kitchen in 6 apartments",`
`4`	`"permanent": false,`
`5`	`"due_date": "2024-11-30 09:00",`
`6`	`"cost_code": "123456",`
`7`	`"budget_hours": 120,`
`8`	`"priority": false,`
`9`	`"completed": false,`
`10`	`"deleted": false`
`11`	`}`

`1`	`{`
`2`	`"id": "dfb37a1e-692e-44d5-bedf-309b44b9e136",`
`3`	`"name": "99 Bamford St",`
`4`	`"description": "Renovating kitchen in 6 apartments",`
`5`	`"permanent": true,`
`6`	`"due_date": "2024-11-30 09:00",`
`7`	`"cost_code": "123456",`
`8`	`"completed": true,`
`9`	`"deleted": true,`
`10`	`"groups": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],`
`11`	`"people": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],`
`12`	`"materials": [{ "id": "03b133a9-4546-4e73-89c8-119fb5042fdb", "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "quantity": 5}],`
`13`	`"notes": [{ "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "note": "Concrete has cat paw prints on it."}]`
`14`	`}`

`1`	`[`
`2`	`{`
`3`	`"id": "b6cc9e4b-cccb-4206-92a0-a387ff121c69",`
`4`	`"first_name": "Aspen",`
`5`	`"last_name": "Brewster",`
`6`	`"email": "[email protected]",`
`7`	`"pin_enabled": false,`
`8`	`"pin": null,`
`9`	`"permission": 3,`
`10`	`"last_updated": "2024-09-09T02:44:06.604Z",`
`11`	`"created": "2024-09-09T02:44:06.604Z"`
`12`	`},`
`13`	`{`
`14`	`"id": "2d68300b-f34e-45f9-a1a5-fdf0daa59729",`
`15`	`"first_name": "Bryne",`
`16`	`"last_name": "Lynton",`
`17`	`"email": null,`
`18`	`"pin_enabled": false,`
`19`	`"pin": null,`
`20`	`"permission": 3,`
`21`	`"last_updated": "2024-09-09T02:44:06.604Z",`
`22`	`"created": "2024-09-09T02:44:06.604Z"`
`23`	`}`
`24`	`]`

API-Referenz

Erste Schritte

Erste Schritte mit Bruno

Erste Schritte mit Postman

Referenz

Gruppen abrufen

Beispielabfrage

Beispielantwort

Aufträge abrufen

Parameters

Example Query

Beispielantwort

Auftrag hinzufügen

Body

Example Query

Beispielantwort

Aufträge löschen

Body

Example Query

Beispielantwort

Auftrag aktualisieren

Body

Example Query

Beispielantwort

Terminals abrufen

Beispielabfrage

Beispielantwort

Materialien abrufen

Beispielabfrage

Beispielantwort

Personen abrufen

Beispielabfrage

Beispielantwort

Schichten abrufen

Parameter

Example Query

Beispielantwort

Wir helfen Ihnen jederzeit gern. Melden Sie sich bei uns und wir tun unser Bestes, damit unser Zeiterfassungssystem zu Ihnen passt.

Wir helfen Ihnen jederzeit gern.
Melden Sie sich bei uns und wir tun unser Bestes, damit unser Zeiterfassungssystem zu Ihnen passt.