Skip to content
Last updated

Introduction

Welcome to WebWork Tracker REST API V2

WebWork Tracker REST API V2 provides programmatic access to your workspace data, allowing you to integrate WebWork Tracker functionality into your own applications, scripts, and workflows.

What is the REST API V2?

The REST API V2 is a modern, RESTful API that enables you to:

  • Manage Workspaces - Access and manage workspace information
  • Manage Members - Invite, update, and manage team members
  • Manage Projects - Create, update, and organize projects
  • Manage Tasks - Create and manage tasks within projects
  • Manage Time Requests - Create, approve, and reject manual time requests
  • Track Time - Access time tracking data and timesheets
  • Manage Leaves - Handle leave requests and balances
  • Manage Expenses - Track and manage expenses
  • Manage Contracts - Handle project-member assignments

API Overview

Base URL

All API requests should be made to:

  • Production: https://api.webwork-tracker.com/api/v2

Important: All endpoints use the /api/v2/ prefix. For example:

  • /api/v2/workspaces
  • /api/v2/projects
  • /api/v2/members

Response Format

All API responses are in JSON format and follow a consistent structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "api_version": "2.0.0",
    "timestamp": "2024-01-15T10:30:00Z",
    "pagination": { ... }
  }
}

HTTP Methods

The API uses standard HTTP methods:

  • GET - Retrieve resources
  • POST - Create new resources
  • PUT - Update existing resources
  • DELETE - Remove resources

Authentication

The API supports two authentication methods:

  • OAuth2 - For applications requiring user authorization
  • Personal Access Tokens - For simple integrations and scripts

For detailed authentication instructions, see the Authorization page.

Rate Limiting

API requests are rate-limited to ensure fair usage:

  • Rate Limit: 60 requests per minute per authenticated user
  • Rate limit information is included in response headers

Pagination

Many endpoints support pagination for efficient data retrieval:

  • page: The current page number (default: 1)
  • per_page: Number of items per page (default: 20, max: 100)
  • total: Total number of available records
  • last_page: Total number of pages

Access Requirements

Important: REST API V2 access is restricted to:

  • Workspace Owners
  • Executive Managers

Only users with these roles can access the API. If you don't have the required role, contact your workspace owner or administrator.

Getting Started

  1. Set up Authentication - Create an OAuth2 app or Personal Access Token (see Authorization)
  2. Explore Endpoints - Browse the available endpoints in the sidebar
  3. Make Your First Request - Start with the /api/v2/workspaces endpoint to get your workspace IDs
  4. Use Workspace IDs - Use workspace IDs in subsequent requests to access workspace-specific data

Need Help?

 
Next page