Create and manage calculation projects. Each user can have multiple projects to organize their calculations.
List Projects
List all projects for the authenticated user.
query Parameters
limitintegerNumber of projects per page
Default: 25pageintegerPage number
Default: 1statestring · enumFilter by project state
Enum values:activearchiveddeletedDefault: active
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
List of projects
projectsobject[] · requiredpaginationobject · required
Create Project
Create a new project to organize your calculations.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
namestring · requiredProject name
projectNumberstringOptional project number
clientNamestringOptional client name
buildingStandardstring · enumBuilding standard/code region (US=United States, EU=Europe/Eurocode, AU=Australia, CA=Canada, NZ=New Zealand)
Enum values:USEUAUCANZDefault: USunitSystemstring · enumUnit system (FPS=Imperial, MKS=Metric)
Enum values:FPSMKSDefault: FPS
Responses
Project created successfully
projectIdstring · uuid · requiredUnique identifier for the created project
namestring · requiredProject name
Get Project
Get details of a specific project.
path Parameters
projectIdstring · requiredProject UUID
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Project details
projectIdstring · uuid · requiredUnique identifier for the project
namestring · requiredProject name
List Project Sheets
List all calculation sheets in a project.
path Parameters
projectIdstring · requiredProject UUID
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
List of sheets in the project
sheetsobject[] · requiredpaginationobject · required