Timeboxes

Get timeboxes

get/api/v1/timeboxes

Request

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

Query parameters

filter[search]string nullable

Searches timeboxes by name using partial matching.

filter[active]boolean nullable

Returns only Timeboxes where the current date is on or before the endDate (i.e. in progress or future).

includeTimeboxControllerListInclusionType[] nullable

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

  • CREATOR - The user who created the timebox.
  • BACKLOG_ITEMS - The backlog items assigned to this timebox.
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 timeboxes 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:

  • name
  • startDate
  • endDate
  • updatedAt

Response

Successfully retrieved the list of timeboxes and their included relationships.

metaunknown
linksunknown

Changes

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