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:Calendar (
/calendars/...) and IDS (/ids/...) endpoints use the base URL https://api.comstruct.com without the /v1 prefix.Authentication
All endpoints require API key authentication via thex-api-key header:
Permissions (scopes)
API keys have specific permissions in the formatresource:action. Each endpoint only requires the scopes relevant to it; required permissions are shown per endpoint.
Available permissions:
As an administrator, you can create API keys yourself in the comstruct application: Administration → API keys. There you configure permission scopes and receive the key once at creation time.Alternatively, your Customer Success Manager can help you with setup.
API endpoint groups
Projects
Project management and queries.
- List projects
- Create/update project
- Get project by ID
- List project components
- Import SAP projects
Deliveries
Delivery note management.
- List deliveries
- Create delivery notes
- Patch deliveries and set delivery components
- OpenTrans/PAHM/Custom formats
Invoices
Invoice processing.
- List and retrieve invoices
- Upload invoices
- AI-assisted analysis
Master data
Manage reference data.
- Accounts
- Payment terms
- Tax codes
- Company codes
- Project regions
Rate limits
The API enforces rate limiting to ensure fair usage and system stability. Limits are applied per IP address.
When the limit is exceeded, requests may be throttled or denied with HTTP
403 Forbidden. Implement exponential backoff and retry logic in your integrations to handle rate limit responses gracefully.
HTTP status codes
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.