---
title: "Create a sprint"
method: POST
path: "/api/teams/sprints"
tags: ["Sprints"]
---

# Create a sprint

`POST /api/teams/sprints`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/teams/sprints`
- Auth: API key in header `X-API-KEY`

Create a new sprint. The team ID must be provided in the relationships.team field of the request body. Optionally, backlog items can be associated with the sprint by providing their IDs in the relationships.backlogItems field.

## Request body

- RequestSprintCreationResource
  - `data` SprintCreationResource, required
    - `type` string, required
    - `attributes` SprintCreationResourceSprintAttributes, required
      - `name` string, required
      - `startDate` string, date-time, required
      - `endDate` string, date-time, required
      - `description` string, required
    - `relationships` SprintCreationResourceSprintRelationships, required
      - `team` SingleRelationship, required
        - `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, required
        - `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

## Response `200`

The sprint that was created

- SingleResourceBodySprintResource
  - `data` SprintResource
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` SprintResourceSprintAttributes, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `name` string, required
      - `startDate` string, date-time, required
      - `endDate` string, date-time, required
      - `description` string, required
    - `relationships` SprintResourceSprintRelationships, required
      - `team` SingleRelationship, required
        - `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
      - `creator` SingleRelationship, required
        - `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, required
        - `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
    - `meta` SprintResourceSprintMetadata, required
      - `storyCount` integer, required
      - `bugCount` integer, required
      - `storyPointTotal` integer, nullable
      - `projectedCapacity` integer, nullable
      - `allowedActions` string[], 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

- `400`: Invalid sprint data
- `404`: Team not found
- `409`: Sprint dates overlap with existing sprint
- `500`: Unexpected error

---

[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)
