Doku

Feuerwehrleute

Verwalten Sie Feuerwehrleute — auflisten, erstellen, aktualisieren und löschen Sie Personal in Ihrer Abteilung.

Überblick #

Die Feuerwehrleute-API bietet vollständige CRUD-Operationen zur Verwaltung von Personalakten. Alle Endpunkte sind auf Ihren Mandanten beschränkt — Sie können nur auf Feuerwehrleute Ihrer Abteilung zugreifen.

Feldreferenz #

Name Type Description
id uuid Optional Eindeutiger Bezeichner
firstName string Required Vorname (1-100 Zeichen)
lastName string Required Nachname (1-100 Zeichen)
phoneNumber string Optional Telefonnummer (bis zu 50 Zeichen)
email string Optional E-Mail-Adresse
dateOfBirth datetime Optional Geburtsdatum (ISO 8601)
invitationStatus string Optional Einladungsstatus zur Plattform
userId uuid Optional Verknüpfte Benutzerkonto-ID

Feuerwehrleute auflisten #

Gibt eine paginierte Liste von Feuerwehrleuten zurück. Unterstützt Suche, Sortierung und Paginierung.

GET /api/v1/firefighters

Abfrageparameter

Name Type Description
page integer Optional Seitennummer (Standard: 1)
pageSize integer Optional Einträge pro Seite (Standard: 20, Max: 100)
search string Optional Suche nach Name, E-Mail oder Telefon
sortBy string Optional Sortierfeld (z.B. firstName, lastName)
sortDir string Optional Sortierrichtung: asc oder desc (Standard: desc)
bash Request 
curl -X GET "https://app.firecustos.com/api/v1/firefighters?page=1&pageSize=10&search=Ivan" \
  -H "Authorization: Bearer fc_your_api_key_here"

200 OK

json Response 
{
  "data": {
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "firstName": "Ivan",
        "lastName": "Horvat",
        "phoneNumber": "+385 91 234 5678",
        "email": "[email protected]",
        "dateOfBirth": "1990-05-15T00:00:00Z",
        "invitationStatus": null,
        "userId": null
      }
    ],
    "page": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  },
  "totalCount": 1
}

Feuerwehrmann abrufen #

Gibt einen einzelnen Feuerwehrmann nach ID zurück.

GET /api/v1/firefighters/{id}

Pfadparameter

Name Type Description
id uuid Required UUID des Feuerwehrmanns
bash Request 
curl -X GET https://app.firecustos.com/api/v1/firefighters/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Bearer fc_your_api_key_here"

200 OK

json Response 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "firstName": "Ivan",
  "lastName": "Horvat",
  "phoneNumber": "+385 91 234 5678",
  "email": "[email protected]",
  "dateOfBirth": "1990-05-15T00:00:00Z",
  "invitationStatus": null,
  "userId": null
}

Feuerwehrmann erstellen #

Erstellt einen neuen Feuerwehrmann-Datensatz.

POST /api/v1/firefighters

Anfragekörper

Name Type Description
firstName string Required Vorname (1-100 Zeichen)
lastName string Required Nachname (1-100 Zeichen)
phoneNumber string Optional Telefonnummer (bis zu 50 Zeichen)
email string Optional E-Mail-Adresse
dateOfBirth datetime Optional Geburtsdatum (ISO 8601)
bash Request 
curl -X POST https://app.firecustos.com/api/v1/firefighters \
  -H "Authorization: Bearer fc_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Marko","lastName":"Perić","phoneNumber":"+385 98 765 4321","email":"[email protected]","dateOfBirth":"1985-03-22T00:00:00Z"}'

201 Created

json Response 
{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "firstName": "Marko",
  "lastName": "Perić",
  "phoneNumber": "+385 98 765 4321",
  "email": "[email protected]",
  "dateOfBirth": "1985-03-22T00:00:00Z",
  "invitationStatus": null,
  "userId": null
}

Feuerwehrmann aktualisieren #

Aktualisiert einen bestehenden Feuerwehrmann-Datensatz. Alle Felder im Anfragekörper sind erforderlich — dies ist eine vollständige Ersetzung.

PUT /api/v1/firefighters/{id}

Pfadparameter

Name Type Description
id uuid Required UUID des Feuerwehrmanns

Anfragekörper

Name Type Description
firstName string Required Vorname (1-100 Zeichen)
lastName string Required Nachname (1-100 Zeichen)
phoneNumber string Optional Telefonnummer (bis zu 50 Zeichen)
email string Optional E-Mail-Adresse
dateOfBirth datetime Optional Geburtsdatum (ISO 8601)
bash Request 
curl -X PUT https://app.firecustos.com/api/v1/firefighters/7c9e6679-7425-40de-944b-e07fc1f90ae7 \
  -H "Authorization: Bearer fc_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Marko","lastName":"Perić","phoneNumber":"+385 98 765 0000","email":"[email protected]","dateOfBirth":"1985-03-22T00:00:00Z"}'

200 OK

json Response 
{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "firstName": "Marko",
  "lastName": "Perić",
  "phoneNumber": "+385 98 765 0000",
  "email": "[email protected]",
  "dateOfBirth": "1985-03-22T00:00:00Z",
  "invitationStatus": null,
  "userId": null
}

Feuerwehrmann löschen #

Löscht einen Feuerwehrmann-Datensatz (weiches Löschen).

DELETE /api/v1/firefighters/{id}

Pfadparameter

Name Type Description
id uuid Required UUID des Feuerwehrmanns
bash Request 
curl -X DELETE https://app.firecustos.com/api/v1/firefighters/7c9e6679-7425-40de-944b-e07fc1f90ae7 \
  -H "Authorization: Bearer fc_your_api_key_here"

204 No Content

On success, the API returns an empty response with status 204.