Epics API

Epics belong to releases. This means that if you want to create one then you must scope it to a release.

You can list them all at once, or filter by release or product. All these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.

Once you have the id of a specific epic, you can inspect, modify, or delete them on the root epics resource.

List epics in a release

GET /api/v1/releases/:release_id/epics

Parameters
Name	Description
`release_id *`	Numeric ID or key of the release
`q`	Search term to match against epic name
`updated_since`	UTC timestamp (in ISO8601 format). If provided, only epics updated after the timestamp will be returned
`tag`	String tag value. If provided, only epics with the associated tag will be returned
`assigned_to_user`	ID or email address of a user. If provided, only epics assigned to that user will be returned

Example request

GET /api/v1/releases/PRJ1-R-1/epics

Example CURL command

curl -g "https://company.aha.io/api/v1/releases/PRJ1-R-1/epics" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Response

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

Response body