Skip to main content

​
Overview

The comstruct API provides a RESTful interface for construction materials procurement. This reference documents all available endpoints with interactive “Try it” features.

​
Base URL

Send all API requests to: 
https://api.comstruct.com/v1
Calendar endpoints use the base URL https://api.comstruct.com without the /v1 prefix.

​
Authentication

All endpoints require API key authentication via the x-api-key header: 
curl -X GET "https://api.comstruct.com/v1/projects" \
  -H "x-api-key: YOUR_API_KEY"

​
Permissions (scopes)

API keys have specific permissions in the format resource:action. Each endpoint only requires the scopes relevant to it; required permissions are shown per endpoint. Available permissions:
PermissionDescription
projects:readRead project data
projects:writeCreate and update projects
deliveries:readRead delivery data
deliveries:writeCreate and update deliveries
invoices:readRead invoice data
invoices:writeCreate and update invoices
project_regions:readRead project region data
project_regions:writeCreate and update project regions
accounts:readRead account data
accounts:writeCreate and update accounts
payment_terms:readRead payment term data
payment_terms:writeCreate and update payment terms
tax_codes:readRead tax code data
tax_codes:writeCreate and update tax codes
users:readRead user data (project user management)
roles:readRead role data (project role assignment)
tenant_settings:readRead tenant settings
suppliers:writeCreate and update suppliers
purchase_orders:writeCreate purchase orders
Contact your Customer Success Manager to get your API key configured with the required permissions.

​
API endpoint groups

Projects

Project management and queries.
  • List projects
  • Create/update project
  • Get project by ID
  • Import SAP projects

Deliveries

Delivery note management.
  • List deliveries
  • Create delivery notes
  • OpenTrans/PAHM/Custom formats

Invoices

Invoice processing.
  • List invoices
  • Upload invoices
  • AI-assisted analysis

Master data

Manage reference data.
  • Accounts
  • Payment terms
  • Tax codes
  • Project regions

​
HTTP status codes

CodeDescription
200Success
201Created
400Bad request
401Unauthorized
403Forbidden – missing permission
404Not found
500Server error

​
Interactive API documentation

Each endpoint page includes a “Try it” feature so you can test API calls directly. Enter your API key and try the endpoints.

OpenAPI specification

Download the full OpenAPI 3.0 specification.