Release phases

List release phases in the account

Changed on
get/release_phases

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

Response

Successful operation

Example response

{
  "release_phases": [
    {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "duration_source": "duration_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "notable_id": "20526005",
        "notable_type": "ReleasePhase",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "integration_fields": [],
      "custom_fields": []
    },
    {
      "id": "405824017",
      "name": "Beta",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "milestone",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "duration_source": "duration_manual",
      "description": {
        "id": "965145324",
        "body": "Description of release phase 2",
        "notable_id": "405824017",
        "notable_type": "ReleasePhase",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "integration_fields": [],
      "custom_fields": []
    },
    {
      "id": "792154778",
      "name": "Beta [2]",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "milestone",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "duration_source": "duration_manual",
      "description": null,
      "integration_fields": [],
      "custom_fields": []
    },
    {
      "id": "827574075",
      "name": "Gamma",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "milestone",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "duration_source": "duration_manual",
      "description": null,
      "integration_fields": [],
      "custom_fields": [
        {
          "id": 816664815,
          "key": "text_field",
          "name": "TextField1",
          "updatedAt": "2019-01-01T00:00:00Z",
          "type": "string",
          "value": "Hot dog taco"
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      endpoint added