clocko:do API:
Mitarbeiter verwalten

Objekttyp „user“

Parameter Typ Beschreibung
idinteger
Die ID des Mitarbeiters
namestring
Der Name des Mitarbeiter
numberstring|null
Personalnummer
emailstring
Die E-Mail-Adresse des Mitarbeiters
rolestring
Die Rolle des Mitarbeiters
activeboolean
Ist der Mitarbeiter aktiviert?
timeformat_12hboolean
Nutzt der Mitarbeiter das 12h-Zeitformat?
weekstart_mondayboolean
Ist der Wochenanfang für den Mitarbeiter Montag?
Falls nicht, beginnt die Woche am Sonntag
weekend_fridayboolean
Ist das Wochenende für den Mitarbeiter Freitag und Samstag?
Falls nicht, ist das Wochenende Samstag und Sonntag
languagestring
Sprache
Erlaubte Werte: 'de', 'en', 'fr'
timezonestring
Zeitzone des Mitarbeiters
z.B. 'Europe/Berlin'
wage_typeinteger|null
Lohnart (nur relevant für DATEV-Export)
Erlaubte Werte: 1 (Gehalt), 2 (Stundenlohn)
can_generally_see_absencesboolean
Darf der Mitarbeiter Abwesenheiten anderer Mitarbeiter sehen?
Nur änderbar für Mitarbeiter mit der Rolle 'worker'
can_generally_manage_absencesboolean
Darf der Mitarbeiter Abwesenheiten anderer Mitarbeiter bearbeiten?
Nur änderbar für Mitarbeiter mit der Rolle 'manager'
can_add_customersboolean
Darf der Mitarbeiter Kunden anlegen?
Nur änderbar für Mitarbeiter mit der Rolle 'worker'
edit_lockstring|null
Festgelegte Bearbeitungssperre für den Mitarbeiter
null (Keine Bearbeitungssperre)
YYYY-MM-DD (Nicht bearbeitbar bis)
edit_lock_dyninteger|null
Dynamische Bearbeitungssperre für den Mitarbeiter
null (Keine Bearbeitungssperre)
1 (Heute bearbeitbar)
2 (Heute und Gestern bearbeitbar)
3 (Heute und 2 Tage rückwirkend bearbeitbar)
5 (Heute und 4 Tage rückwirkend bearbeitbar)
8 (Heute und eine Woche rückwirkend bearbeitbar)
15 (Heute und 2 Wochen rückwirkend bearbeitbar)
31 (Heute und 30 Tage rückwirkend bearbeitbar)
46 (Heute und 45 Tage rückwirkend bearbeitbar)
91 (Heute und 90 Tage rückwirkend bearbeitbar)
edit_lock_syncboolean|null
Kann die für den Mitarbeiter geltende Bearbeitungssperre durch eine Änderung der firmenweiten Bearbeitungssperre überschrieben werden?
worktime_regulation_idinteger|null
Für den Mitarbeiter geltende Arbeitszeitvorschrift
"0" wenn keine Arbeitszeitvorschrift gilt
"null" wenn der Firmenstandard gilt
teams_idinteger
Die ID des Teams, dem der Mitarbeiter zugeordnet ist

Mitarbeiter auflisten

Anfrage
GET /api/users
Antwort
{
  "users": 
  {
    [object of type user],
    [object of type user], ...
  }
}

Einen Mitarbeiter abrufen

Anfrage
GET /api/users/[ID]
Antwort
{
  "user": [object of type user]
}

Mitarbeiter anlegen

Anfrage
POST /api/users
Notwendige Parameter name, email, role

Der Parameter mail_to_user bestimmt, ob eine E-Mail an den neuen Mitarbeiter versendet wird (Default: false).

Optionale Parameter mail_to_user, number, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock_sync, teams_id
Antwort
{
  "user": [object of type user]
}

Mitarbeiter bearbeiten

Anfrage
PUT /api/users/[ID]
Notwendige Parameter keine
Optionale Parameter name, number, active, role, timeformat_12h, weekstart_monday, weekend_friday, language, timezone, wage_type, can_generally_see_absences, can_generally_manage_absences, can_add_customers, edit_lock, edit_lock_dyn, edit_lock_sync, teams_id
Antwort
{
  "user": [object of type user]
}

Mitarbeiter deaktivieren

Anfrage
DELETE /api/users/[ID]
Antwort
{
  "user": [object of type user]
}
stripes illustration
Kontaktieren Sie uns!

Unser Customer-Success-Team steht Ihnen für Fragen zur Verfügung! 

Jetzt kontaktieren!

Alle Funktionen 14 Tage kostenlos testen

Mit dem Absenden des Formulars akzeptieren Sie unsere AGB und unsere Datenschutz­erklärung und bestätigen, dass Sie clockodo als Unternehmer nutzen.

Nutzen Sie die Erfahrungen von 6.000 weiteren Unternehmen:

Bechtle Mannheim LogoBechtlePeerigon LogoPeerigon GmbH
Phoenix Logistik LogoPhoenix LogistikFieda LogoFidea