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",
      "external_id": "EXT-001"
    },
    {
      "id": "23d12932-2348-345d-b342-2323cd846323",
      "title": "23043 - Example Site 2",
      "project_number": null,
      "description": "Description",
      "external_id": "EXT-002"
    }
  ]
}

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