Spaces

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

API-Endpunkt:

GET 
https://pcx365.de/api/v1/spaces

Anfragebeispiel: 

curl --location --request GET 'https://pcx365.de/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suchen nach. Mögliche Werte sind: name für Name. Standardmäßig: name.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, name für Name. Standardmäßig: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardmäßig: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardmäßig: 10.
Anzeigen

API-Endpunkt:

GET 
https://pcx365.de/api/v1/spaces/{id}

Anfragebeispiel: 

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

API-Endpunkt:

POST 
https://pcx365.de/api/v1/spaces

Anfragebeispiel: 

curl --location --request POST 'https://pcx365.de/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
The space name.
color
optional integer
The color code. Mögliche Werte sind: 1, 2, 3, 4, 5, 6. Standardmäßig: 1.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://pcx365.de/api/v1/spaces/{id}

Anfragebeispiel: 

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

API-Endpunkt:

DELETE 
https://pcx365.de/api/v1/spaces/{id}

Anfragebeispiel: 

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