Schedules API

The Schedules API provides access to capacity planning and work scheduling functionality. Schedules define working hours, velocity, and capacity metrics for teams and individuals to support enhanced capacity planning and resource management.

Core Functionality:

  • Working Hours - Define hours per day and weekly schedules
  • Velocity Planning - Story points per day and team velocity metrics
  • Calendar Management - Weekly schedule with individual day configurations
  • Capacity Planning - Resource allocation and workload management

Enterprise Features:

  • Enhanced capacity planning functionality
  • Team-level schedule management
  • Resource optimization and workload balancing

Authentication: Standard API authentication (OAuth, session cookies, HTTP Basic until 2025). Requires enhanced capacity planning feature to be enabled for the account.

List schedules

GET /api/v1/schedules

Retrieves schedules for capacity planning, showing working hours, velocity, and weekly patterns

Parameters
NameDescription
page

Page number for pagination

per_page

Number of items per page (default: 20, max: 100)

fields

Comma-separated list of fields to include in response

Example request

GET /api/v1/schedules?fields=name%2Chours_per_day%2Cstory_points_per_day%2Cvelocity%2Cmonday%2Ctuesday%2Cwednesday%2Cthursday%2Cfriday%2Csaturday%2Csunday

Example CURL command

curl -g "https://company.aha.io/api/v1/schedules?fields=name%2Chours_per_day%2Cstory_points_per_day%2Cvelocity%2Cmonday%2Ctuesday%2Cwednesday%2Cthursday%2Cfriday%2Csaturday%2Csunday" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body