Zum Hauptinhalt springen
GET
/
project-regions
Projektregionen auflisten
curl --request GET \
  --url https://api.comstruct.com/v1/project-regions \
  --header 'X-API-Key: <api-key>'
{
  "projectRegions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "North Region",
      "number": "REG-NORTH",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "hasNext": true,
  "hasPrevious": true,
  "totalPages": 123,
  "currentPage": 123
}

Autorisierungen

​
X-API-Key
string
header
erforderlich

API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.

Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.

Abfrageparameter

​
limit
integer
Standard:25

Maximale Anzahl der Projektregionen pro Seite

Erforderlicher Bereich: 1 <= x <= 500
​
offset
integer
Standard:0

Anzahl der zu überspringenden Projektregionen für die Paginierung

Erforderlicher Bereich: x >= 0

Antwort

Paginierte Projektregionen erfolgreich abgerufen

​
projectRegions
object[]
​
total
integer

Gesamtanzahl der Projektregionen

​
limit
integer | null

Anzahl der Einträge pro Seite

​
offset
integer

Anzahl der übersprungenen Einträge

​
hasNext
boolean

Ob weitere Seiten verfügbar sind

​
hasPrevious
boolean

Ob vorherige Seiten verfügbar sind

​
totalPages
integer

Gesamtanzahl der Seiten

​
currentPage
integer

Aktuelle Seitennummer (0-basiert)