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

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

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

Anzahl der zu überspringenden Projekte für die Paginierung

Required range: x >= 0

Response

Erfolgreich

​
projects
object[]
​
total
integer

Gesamtanzahl der Projekte

Example:

150

​
limit
integer | null

Anzahl der Einträge pro Seite

Example:

25

​
offset
integer

Anzahl der übersprungenen Einträge

Example:

0

​
hasNext
boolean

Ob weitere Seiten verfügbar sind

Example:

true

​
hasPrevious
boolean

Ob vorherige Seiten verfügbar sind

Example:

false

​
totalPages
integer

Gesamtanzahl der Seiten

Example:

6

​
currentPage
integer

Aktuelle Seitennummer (0-basiert)

Example:

0