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/v1/projects

Base URL

All API requests must be made to:

https://api.workload.com/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

Allocations

GET/v1/allocationsList allocations
POST/v1/allocationsCreate an allocation

Team

GET/v1/team-membersList team members

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
  • allocation.created - An allocation is created
  • allocation.updated - An allocation is updated
  • team-member.added - A member is added to the team

Complete Documentation

To access the complete API documentation with all details, code examples and schemas:

Available for plans:

  • Professional and above
  • Access from dashboard: /dashboard/settings/api

Need help? Contact our support team.