Zum Hauptinhalt springen
GET
/
projects
Projekte auflisten
curl --request GET \
  --url https://api.comstruct.com/v1/projects \
  --header 'X-API-Key: <api-key>'
{
  "projects": [
    {
      "id": "cefa2499-e11d-cada-b423-c3af41ae5232",
      "title": "Example Site 1",
      "project_number": "23423420",
      "description": "Description",
      "region": "Bavaria",
      "address": {
        "address": "Example Street",
        "city": "Munich",
        "country": "DE",
        "house_number": "1",
        "zip": "80331"
      },
      "alternative_project_number": "ALT-23423420",
      "legal_entity": {
        "id": "11111111-1111-1111-1111-111111111111",
        "title": "Example Legal Entity",
        "number": "LE-001"
      },
      "external_id": "EXT-001",
      "active": true
    },
    {
      "id": "23d12932-2348-345d-b342-2323cd846323",
      "title": "23043 - Example Site 2",
      "project_number": null,
      "description": "Description",
      "region": "Berlin",
      "address": {
        "address": "Sample Avenue",
        "city": "Berlin",
        "country": "DE",
        "house_number": "2",
        "zip": "10115"
      },
      "alternative_project_number": null,
      "legal_entity": {
        "id": "22222222-2222-2222-2222-222222222222",
        "title": "Sample Legal Entity",
        "number": "LE-002"
      },
      "external_id": "EXT-002",
      "active": false
    }
  ]
}

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 Projekte pro Seite

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

Anzahl der zu überspringenden Projekte für die Paginierung

Erforderlicher Bereich: x >= 0

Antwort

Erfolgreich

projects
object[]
total
integer

Gesamtanzahl der Projekte

Beispiel:

150

limit
integer | null

Anzahl der Einträge pro Seite

Beispiel:

25

offset
integer

Anzahl der übersprungenen Einträge

Beispiel:

0

hasNext
boolean

Ob weitere Seiten verfügbar sind

Beispiel:

true

hasPrevious
boolean

Ob vorherige Seiten verfügbar sind

Beispiel:

false

totalPages
integer

Gesamtanzahl der Seiten

Beispiel:

6

currentPage
integer

Aktuelle Seitennummer (0-basiert)

Beispiel:

0