SHshiprush
Schedules

List schedules

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

get/schedules

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring
per_pagestring
fieldsstring

Response

Successful operation

Example response

{
  "schedules": [
    {
      "id": "54870801",
      "name": "Another schedule",
      "hours_per_day": "10.0",
      "story_points_per_day": "5.0",
      "velocity": "10.0"
    },
    {
      "id": "441193141",
      "name": "Default schedule",
      "hours_per_day": "8.2",
      "story_points_per_day": "1.0",
      "velocity": "10.5"
    },
    {
      "id": "876770204",
      "name": "Child schedule",
      "hours_per_day": "19.0",
      "story_points_per_day": "28.0",
      "velocity": null
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.