Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Common API request examples for the BuildingSwell v2 API.
curl "https://app.buildingswell.com/api/v2/project?page=1&pageSize=20" \ -H "X-API-Key: <key>"
curl "https://app.buildingswell.com/api/v2/deliverable?filter=progress.status eq 'wip' and type eq 'stage'" \ -H "X-API-Key: <key>"
curl -X POST "https://app.buildingswell.com/api/v2/deliverable" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '{ "type": "phase", "name": "Foundation", "quantity": 1 }'
curl -X POST "https://app.buildingswell.com/api/v2/deliverable" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '[{ "type": "phase", "name": "Foundation" }, { "type": "phase", "name": "Framing" }]'
curl -X PATCH "https://app.buildingswell.com/api/v2/project/<id>" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '{ "scheduledEndDate": "2024-12-31" }'
curl -X PATCH "https://app.buildingswell.com/api/v2/deliverable/bulk?type=step" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '{ "costCode": "LABOR-001" }'
curl "https://app.buildingswell.com/api/v2/deliverable/count?filter=progress.status ne 'done' and isArchived eq false" \ -H "X-API-Key: <key>"
curl -X POST "https://app.buildingswell.com/api/v2/deliverable/group-and-count" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '{ "groupByField": "type" }'
curl "https://app.buildingswell.com/api/v2/deliverable?join:project:id,name=projectId%20eq%20relation.id&type=phase" \ -H "X-API-Key: <key>"
curl "https://app.buildingswell.com/api/v2/deliverable/export?isArchived:eq=false" \ -H "X-API-Key: <key>" \ -o deliverables.xlsx
curl -X POST "https://app.buildingswell.com/api/v2/deliverable/import" \ -H "X-API-Key: <key>" \ -F "file=@deliverables.xlsx" \ -F "timezone=America/New_York"
curl -X POST "https://app.buildingswell.com/api/v2/deliverable/query" \ -H "X-API-Key: <key>" \ -H "Content-Type: application/json" \ -d '{ "filter": "type eq '\''phase'\'' and isArchived eq false", "page": 1, "pageSize": 100 }'
curl "https://app.buildingswell.com/api/v2/concepts" -H "X-API-Key: <key>"
curl -X POST "https://app.buildingswell.com/api/v2/concepts/deliverables" \ -H "X-API-Key: <key>" -H "Content-Type: application/json" \ -d '{ "type": "stage", "name": "Welding", "parentId": "<phaseId>", "data": { "shopId": "<departmentId>" } }'
curl -X POST "https://app.buildingswell.com/api/v2/concepts/orders/from-route" \ -H "X-API-Key: <key>" -H "Content-Type: application/json" \ -d '{ "routeId": "<routeId>", "projectId": "<projectId>", "name": "ORD for Customer X" }'
curl "https://app.buildingswell.com/api/v2/concepts/orders/<orderId>/context" -H "X-API-Key: <key>"
curl -X POST "https://app.buildingswell.com/api/v2/concepts/root/<orderId>/progress/<nodeId>/plan" \ -H "X-API-Key: <key>" -H "Content-Type: application/json" \ -d '{ "type": "rework" }'