Gruppen

Notizen
Expertenlevel
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. API-Schlüssel anfordern.
Liste

API endpoint:

GET 
https://jetzt.work/api/v1/spaces

Beispiel für eine Anfrage: 

curl --location --request GET 'https://jetzt.work/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Suchabfrage.
search_by
optional string
Suche nach. Mögliche Werte: name für Name. Standartmäßig: name.
sort_by
optional string
Sortieren nach. Mögliche Werte: id für Erstelldatum, name für Name. Standartmäßig: id.
sort
optional string
Art. Mögliche Werte: desc für Absteigend, asc für Aufsteigend. Standartmäßig: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte: 10, 25, 50, 100. Standartmäßig: 10.
Anzeigen

API endpoint:

GET 
https://jetzt.work/api/v1/spaces/{id}

Beispiel für eine Anfrage: 

curl --location --request GET 'https://jetzt.work/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API endpoint:

POST 
https://jetzt.work/api/v1/spaces

Beispiel für eine Anfrage: 

curl --location --request POST 'https://jetzt.work/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parameter
Typ
Beschreibung
name
erforderlich string
Gruppenname.
color
optional integer
Farbcode. Mögliche Werte: 1, 2, 3, 4, 5, 6. Standartmäßig: 1.
Update

API endpoint:

PUT PATCH 
https://jetzt.work/api/v1/spaces/{id}

Beispiel für eine Anfrage: 

curl --location --request PUT 'https://jetzt.work/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
name
optional string
Gruppenname.
color
optional integer
Farbcode. Mögliche Werte: 1, 2, 3, 4, 5, 6.
Löschen

API endpoint:

DELETE 
https://jetzt.work/api/v1/spaces/{id}

Beispiel für eine Anfrage: 

curl --location --request DELETE 'https://jetzt.work/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'