---
title: "Get a timebox"
method: GET
path: "/api/v1/timeboxes/{id}"
tags: ["Timeboxes"]
---

# Get a timebox

`GET /api/v1/timeboxes/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/v1/timeboxes/{id}`
- Auth: API key in header `X-API-KEY`

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include` TimeboxControllerListInclusionType[], nullable

## Response `200`

Successfully retrieved the timebox and its included relationships.

- SingleResourceBodyTimeboxResourceV1
  - `data` TimeboxResourceV1: A timebox (sprint, iteration, or release) that organizes backlog items within a specific timeframe.
    - `type` string: Identifies the type of resource.
    - `id` string, uuid: The unique identifier for the resource, typically a UUID.
    - `attributes` TimeboxResourceV1Attributes: Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.
      - `name` string: The name of the timebox
      - `description` string: A description of the timebox
      - `createdAt` string, date-time: When the timebox was created
      - `updatedAt` string, date-time: When the timebox was last updated
      - `startDate` string, date-time: The start date of the timebox
      - `endDate` string, date-time: The end date of the timebox
    - `relationships` TimeboxResourceV1Relationships: Contains references to other related resources.
      - `creator` SingleRelationship
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `backlogItems` MultipleRelationships
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

## Other responses

- `403`: The authenticated user does not have permission to access the requested timebox.
- `404`: The timebox could not be found, or one of the requested related resources (include) does not exist.

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)