REST API • v1

PackCompli API Reference

Fully typed REST API to integrate PackCompli into your ERP, MES or document-management system. JSON over HTTPS with bearer-token authentication.

v1.0 — Stable
99.95% uptime SLA
EU data residency

Authentication

All requests authenticate with a workspace bearer token. Tokens scope to a single workspace and role.

curl https://api.packcompli.app/v1/packaging \
  -H "Authorization: Bearer pc_live_8f3e...c92a" \
  -H "Content-Type: application/json"

Endpoints

  • GET
    /v1/packagingList all packaging items
  • POST
    /v1/packagingCreate a packaging entry
  • GET
    /v1/packaging/{id}Retrieve a single item
  • PATCH
    /v1/packaging/{id}Update an entry
  • DELETE
    /v1/packaging/{id}Delete an entry

Example: create a packaging item

Request
POST /v1/packaging
Content-Type: application/json

{
  "name": "Shipping Carton A4",
  "internalId": "PK-CRT-001",
  "type": "Carton",
  "material": "Recycled cardboard 80%",
  "supplier": "GreenPack GmbH",
  "weightG": 240,
  "recyclable": true
}
Response · 201
{
  "id": "pk_8f3e2c91",
  "name": "Shipping Carton A4",
  "status": "yellow",
  "documents": [],
  "createdAt": "2026-06-18T09:14:02Z"
}

Error format

{
  "error": {
    "code": "validation_failed",
    "message": "Field 'material' is required",
    "field": "material"
  }
}
400Bad request
401Unauthorized
403Forbidden
404Not found
429Rate limited
500Server error

Rate limits

600
requests / minute
50 MB
max document size
99.95%
uptime SLA
Ready to integrate?
Generate your workspace token in Settings.
Sign in