Personal

Attribute

{
    "id": 123,
    "active": true,
    "firstname": "Max",
    "lastname": "Muster",
    "email": "max.muster@beispiel.de",
    "mobile_phone": "+49 177 123 45 67",
    "work_phone": "+49 40 123 45 67",
    "home_address": "",
    "info": "",
    "birthday": "1970-01-01",
    "avatar_url": "https//meinefirma.mocoapp.com/.../profil.jpg",
    "custom_properties": {
        "Eintritt": "Januar 2015"
    },
    "unit": {
        "id": 456,
        "name": "Geschäftsleitung"
    }
}

GET users

Abruf aller Mitarbeiter:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/users \
  -H 'authorization: Token token={api-key}'

Die Antwort liefert ein Array mit vollständigen Mitarbeiterinformationen (siehe Attribute).

Zusätzlich sind folgende Parameter möglich:
  • include_archived – true/false

GET users/{id}

Abruf eines einzelnen Mitarbeiters:

curl -X GET \
  https://{domain}.mocoapp.com/api/v1/users/{123} \
  -H 'Authorization: Token token={api-key}'

Die Antwort ist die Repräsentation eines einzelnen Mitarbeiters.

POST users

Erstellen einer Person:

curl -X POST \
  https://{domain}.mocoapp.com/api/v1/users \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'name=Website Relaunch&currency=EUR&leader_id=123456&customer_id=234567'

Pflichtfelder sind mit Stern (*) markiert:
  • firstname* – "Peter"
  • lastname* – "Müller"
  • email* – "peter.mueller@meinefirma.de"
  • password* – "dAfsdf88fw8fKjtD28f293!"
  • unit_id* – 123 (ID eines Teams)
  • active – true/false (aktiviert/deaktiviert)
  • external – true/false (externer Mitarbeiter)
  • language – "de", "de-AT", "de-CH", "en", "it" oder "fr"
  • mobile_phone – "+41 79 123 45 67"
  • work_phone – "+41 44 123 45 67"
  • home_address – "Peter Müller\nBeispielstrasse 123\nBeispielstadt"
  • bday – "1975-01-17"
  • work_phone – "+41 44 123 45 67"
  • custom_properties – {"Einstellungsdatum": "01.01.2016"}
  • info – "Eine Info zur Person..."

PUT users/{id}

Aktualisieren einer Person:

curl -X PUT \
  https://{domain}.mocoapp.com/api/v1/users/{123} \
  -H 'authorization: Token token={api-key}' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'password=d97sd7sdf7ewwfhA!df93'

Felder sind analog zur Erstellung.

DELETE users/{id}

Das Löschen einer Person ist nur möglich, solange keine Zeiten abgerechnet wurden.

curl -X DELETE \
  https://{domain}.mocoapp.com/api/v1/users/{123} \
  -H 'authorization: Token token={api-key}'

Mehr zu API...
30 Tage gratis

Account sofort startbereit. Voller Funktionsumfang. Ohne Zahlungsangaben.