Skip to main content
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
}

Authorizations

​
X-API-Key
string
header
required

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

Erforderliche Berechtigungen:

  • deliveries:read - Lieferdaten lesen
  • deliveries:write - Lieferungen erstellen und ändern
  • invoices:read - Rechnungsdaten lesen
  • invoices:write - Rechnungen erstellen und ändern
  • projects:read - Projektdaten lesen
  • projects:write - Projekte erstellen und ändern
  • project_regions:read - Projektregionsdaten lesen
  • project_regions:write - Projektregionen erstellen und ändern
  • accounts:read - Kontodaten lesen
  • accounts:write - Konten erstellen und ändern
  • payment_terms:read - Zahlungsbedingungsdaten lesen
  • payment_terms:write - Zahlungsbedingungen erstellen und ändern
  • tax_codes:read - Steuercodedaten lesen
  • tax_codes:write - Steuercodes erstellen und ändern
  • users:read - Benutzerdaten lesen (erforderlich für Projekt-Benutzerverwaltung)
  • roles:read - Rollendaten lesen (erforderlich für Projekt-Rollenzuweisung)
  • tenant_settings:read - Mandanteneinstellungen lesen (erforderlich für Projekterstellung)
  • suppliers:write - Lieferanten erstellen und ändern
  • purchase_orders:write - Bestellungen erstellen

Query Parameters

​
limit
integer
default:25

Maximale Anzahl der Projektregionen pro Seite

Required range: 1 <= x <= 500
​
offset
integer
default:0

Anzahl der zu überspringenden Projektregionen für die Paginierung

Required range: x >= 0

Response

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)