Epics

Get epics

get/api/v1/epics

Request

  • Base URL: https://api.atono.io
  • URL: https://api.atono.io/api/v1/epics
  • Auth: API key in header X-API-KEY

Query parameters

filter[createdAt]string nullable

Finds epics created within a specific date range. Provide two pipe-separated ISO 8601 timestamps (e.g., start|end).

Example:2021-01-01T00:00:00Z|2021-01-31T23:59:59Z
filter[keywordSearch]string nullable

Finds epics matching the given string. Case insensitive. Matches both handle and title portions.

filter[updatedAt]string nullable

Finds epics last updated within a specific date range. Provide two pipe-separated ISO 8601 timestamps (e.g., start|end).

Example:2021-01-01T00:00:00Z|2021-01-31T23:59:59Z
includeEpicControllerInclusionType[] nullable

Includes additional related data for each epic. Repeat the parameter to include multiple relationships.

  • CREATOR - The user who created the epic.
  • EPIC_STORIES - The stories associated with the epic.
page[number]integer nullable

Returns a specific page of results, starting from page 0. Use with page[size] to control how many items are returned per page. For example, if page[size] is 20, then page[number]=2 returns items 21-40.

page[size]integer nullable

Controls how many items are returned in each response page.

page[offset]integer nullable

Skips the specified number of items before starting the result set. For example, if page[offset] is 30 and page[size] is 10, the response returns items 31-40.

sortstring[] nullable

Sorts the list of epics by one or more fields. Prefix a field name with a minus sign (-) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include:

  • handle
  • position
  • title
  • createdAt
  • updatedAt

Response

Successfully retrieved the list of epics and their included relationships.

metaunknown
linksunknown

Changes

No recorded changes to this operation across all 1 revision of this API.