API Documentation

Integrate Workload into your applications with our complete REST API

Authentication

The API uses API keys for authentication. Create an API key from your dashboard.

# Usage Example
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.workload.com/api/v1/projects

Base URL

All API requests must be made to:

https://api.workload.com/api/v1

Endpoints

Discover all available endpoints to interact with Workload

Projects

GET/v1/projectsList all projects
POST/v1/projectsCreate a new project
GET/v1/projects/:idProject details

Budgets

GET/v1/budget/project-budgetsList project budgets
POST/v1/budget/project-budgetsCreate a project budget

Vendors and rates

GET/v1/budget/vendorsList vendors
GET/v1/budget/team-ratesList team rates

Scaled agile (opt-in)

Available when scaledAgileEnabled is on for the organization. Scopes: programs:read, planning-increments:read, dependencies:read.

GET/v1/programsList active programs
GET/v1/programs/:idProgram details
GET/v1/planning-incrementsList planning increments (PI)
GET/v1/dependenciesList cross-project dependencies

Optional filter: ?programId= for increments and dependencies

Capacity (allocations SoR)

Scopes documented in OpenAPI v1: team-members:read/write, allocations:read/write, timesheet:read.

GET/v1/team-membersList team members
POST/v1/team-membersCreate a team member
GET/v1/allocationsList allocations
POST/v1/allocationsCreate an allocation
GET/v1/timesheet-entriesList timesheet entries (read)

API scopes — scaled agile

["programs:read","planning-increments:read","dependencies:read"]

Webhooks

Receive real-time notifications on your organization's events

Configure webhooks to be automatically notified when certain events occur:

  • project.created - A project is created
  • project.updated - A project is updated
  • project.budget.created - A project budget is created
  • vendor.created - A vendor is created
  • team.rate.created - A team rate is created

ServiceNow ITSM bridge

No Marketplace connector. CSV / IntegrationHub / REST v1 recipe — incidents and CMDB stay in ServiceNow.

See the ServiceNow bridge recipe →

Complete Documentation

To access quickstart, snippets and the OpenAPI spec:

Developer resources:

  • API Quickstart
  • OpenAPI spec: docs/openapi/v1.yaml
  • API keys endpoint: /api/v1/api-keys

Need help? Contact our support team.