--- title: "Get epics" method: GET path: "/api/v1/epics" tags: ["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`). - `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`). - `include` EpicControllerInclusionType[], nullable - `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. - `sort` string[], nullable ## Response `200` Successfully retrieved the list of epics and their included relationships. - MultiResourceBodyEpicResource - `data` EpicResource[]: A list of returned resources, based on the request. - `type` string: Identifies the type of resource. - `id` string, uuid: The unique identifier for the resource, typically a UUID. - `attributes` EpicResourceAttributes: Contains the structured data fields that describe the resource, such as properties, settings, and timestamps. - `title` string: The title of the epic. - `handle` string: A unique identifier for the epic, shown in the Atono application as the item ID (e.g., `EPIC-123`). - `position` integer: Indicates the epic's position within its current workflow step, where `0` is the topmost item. Position is relative to the step and team backlog. - `content` ContentChunk1[], nullable: A description of the epic, providing additional context and details. - `type` 'DISPLAY_HTML' | 'TEXT' | 'PERSONA', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. - `value` string, required: The content in this chunk. - `additionalContent` ContentChunk3[], nullable: Optional notes added below the acceptance criteria, often used for background info, technical notes, decisions, or context for the team. - `type` 'DISPLAY_HTML' | 'TEXT', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `value` string, required: The content in this chunk. - `createdAt` string, date-time: The date and time the epic was created. - `updatedAt` string, date-time: The date and time the epic was last updated. - `deleted` boolean: Indicates whether the epic has been deleted. - `relationships` EpicResourceRelationships: 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 - `attachments` 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 - `epicStories` 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 --- [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)