> ## Documentation Index > Fetch the complete documentation index at: https://superthread.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get sprint settings > Fetches the sprint settings for the specified project (externally referenced as Space, `project_id`) within a workspace (`team_id`). Includes configurations such as sprint length, layout, statuses, cooldown period, start day of the week, and VCS mappings for automation. ## OpenAPI ````yaml GET /{team_id}/sprints/settings openapi: 3.0.0 info: description: Superthread Public API Specification version: '0.1' title: Public API contact: email: engineering@superthread.com servers: - url: https://api.superthread.com/v1 security: - BearerAuth: [] tags: - name: AI description: >- [Service: AI]. Handles AI-powered functionalities, such as recommendations, predictions, and automation features. - name: Activity description: >- [Service: Activity] Manages all activities; creating notifications and digests - name: Auth description: >- [Service: Auth] Responsible for user authentication, authorization, and session management. - name: Boards description: >- [Service: Boards] Manages core collaboration features such as "boards", "cards", "lists", "sprints", "epics". - name: Comments description: >- [Service: Comments] Handles the creation, editing, and management of comments across various entities. - name: Favourites description: >- [Service: Favourites] Responsible for favouriting resources in the system for quick access. - name: Files description: >- [Service: Files] Manages file uploads, storage, and retrieval for user and project resources. - name: Importer description: >- [Service: Importer] Handles data import operations from external sources into the platform. - name: Integrations description: >- [Service: Integrations] Facilitates connectivity with external tools and services, enabling smooth integration with third-party platforms and APIs. - name: Pages description: >- [Service: Pages] Manages the creation and organization of both public and private pages, supporting structured content and navigation and collaboration. - name: Projects description: '[Service: Projects] Handles all project related tasks.' - name: Reports description: >- [Service: Reports] Generates and manages analytical reports and insights for users and projects. - name: Search description: >- [Service: Search] Provides search functionalities, including indexing and retrieval of platform data. - name: TimeTracking description: >- [Service: TimeTracking] Manages time entries, active timers, time categories, billing rates, and audit/lock for time-tracking workflows. - name: Views description: >- [Feature] Provides tools to create and customize views, enabling users to organize and visualize their data according to their preferences and workflows. - name: OAuth2 description: >- [Feature] Supports OAuth2 integration for seamless user authentication and authorization, ensuring secure access to external APIs and services. - name: Sprints description: >- [Feature] Facilitates sprint management within agile workflows, including planning, progress tracking, and reporting. - name: Cards description: >- [Feature] A Card is the core concept used in the system to describe an individual task or work item. They are used across Boards, Sprints, and Roadmaps. Cards include features like descriptions, checklists, comments, priorities, tags and more. - name: Checklists description: >- [Feature] A Checklist is a list of items that need to be completed. It is used to track progress on a card. - name: Lists description: >- [Feature] Represents a collection of tasks or items grouped within different contexts in the system. Lists (externally referenced as "statuses") are utilized across various entities such as boards, sprints, and roadmaps. - name: Notes description: >- [Feature] Enables users to create, edit, and organize notes, supporting rich text, attachments, transcriptions and AI enhancements. - name: Tags description: >- [Feature] Groups endpoints related to the creation, retrieval, updating, deletion, and merging of tags within teams (workspaces). - name: Agents description: >- [Feature] Manages agents and runs. Provides CRUD operations for agents, launching cloud agents, monitoring agent status, retrieving conversations, and sending follow-ups. paths: /{team_id}/sprints/settings: parameters: - $ref: '#/components/parameters/path_team_id' - $ref: '#/components/parameters/query_required_project_id' get: tags: - Boards - Sprints summary: Get sprint settings for project description: > Fetches the sprint settings for the specified project (externally referenced as Space, `project_id`) within a workspace (`team_id`). Includes configurations such as sprint length, layout, statuses, cooldown period, start day of the week, and VCS mappings for automation. operationId: getSprintSettings responses: '200': description: sprint settings content: application/json: schema: $ref: '#/components/schemas/GetSprintSettingsResponse' default: description: client error content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' components: parameters: path_team_id: in: path name: team_id description: >- Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace". required: true schema: type: string query_required_project_id: in: query name: project_id description: >- Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space". required: true schema: type: string schemas: GetSprintSettingsResponse: type: object properties: sprint_settings: $ref: '#/components/schemas/SprintSettings' Error: type: object properties: id: type: string example: err5f744ab code: type: integer format: int32 example: 403 sec: $ref: '#/components/schemas/SuperthreadErrorCode' message: type: string example: You do not have access to this resource description: A user-friendly error message date: $ref: '#/components/schemas/STime' SprintSettings: type: object properties: statuses: type: array items: $ref: '#/components/schemas/SprintCardStatus' length: type: integer example: 14 description: length of the sprint in days cooldown: type: integer example: 7 description: length of the cooldown period in days start_day: type: integer example: 1 description: >- day of the week to start the sprint (0 = Sunday, 1 = Monday, ..., 6 = Saturday) enabled: type: boolean example: true x-omitempty: false description: whether sprints are enabled for the project vcs_mapping: $ref: '#/components/schemas/VCSMapping' layout: $ref: '#/components/schemas/BoardLayout' time_updated: $ref: '#/components/schemas/STime' user_updated: $ref: '#/components/schemas/Actor' card_cover_enabled: type: boolean description: whether card covers are enabled for the project SuperthreadErrorCode: type: string description: | Superthread Error Code (`SEC`): A structured error code. Format: `SEC:{ServiceID}-{InternalErrorCode}`. - `SEC`: Prefix for all structured error codes. - `ServiceID`: First 3 characters identify the service, '000' is reserved for generic errors. - `InternalErrorCode`: the next (last) 5 characters define the specific error. pattern: ^SEC:\d{3}-\d{5}$ example: SEC:000-00014 STime: type: integer format: int64 example: 1608742037016 description: unix timestamp in seconds x-go-type: type: STime import: package: github.com/superthread-com/common/pkg/types hints: noValidation: true kind: primitive SprintCardStatus: type: object required: - title - status properties: id: type: string description: unique sprint status uuid example: 688a7717-f1ea-4955-9f5f-6eca66e98f64 title: type: string example: To Do x-nullabe: false status: $ref: '#/components/schemas/CardStatus' VCSMapping: type: object description: >- Generic mapping of version control software to automate state of cards in boards. Specifically which list they reside in properties: pr_draft: type: string description: List ID example: '41' pr_open: type: string description: List ID example: '41' pr_review_requested: type: string description: List ID example: '41' pr_merged: type: string description: List ID example: '41' pr_closed: type: string description: List ID example: '41' branches: type: array description: >- A list of VCSMappingItem that defines automation for branch specific workflows. items: $ref: '#/components/schemas/VCSMappingItem' BoardLayout: type: string enum: - board - list - timeline - calendar example: board nullable: true Actor: title: Actor type: object description: describes a user or robot that created or updated a resource properties: user_id: type: string example: uDsu0j19 x-go-custom-tag: dynamodbav:",omitempty" type: type: string x-go-custom-tag: dynamodbav:",omitempty" example: user default: user enum: - user - robot - system nullable: false source: $ref: '#/components/schemas/ActorSource' CardStatus: type: string enum: - committed - started - completed - cancelled example: started VCSMappingItem: type: object description: >- Generic mapping of version control software to automate state of cards in which list they reside in. properties: name: type: string description: Branch name to apply this VCS automation for. example: development pr_draft: type: string description: List ID example: '41' pr_open: type: string description: List ID example: '41' pr_review_requested: type: string description: List ID example: '41' pr_merged: type: string description: List ID example: '41' pr_closed: type: string description: List ID example: '41' time_created: $ref: '#/components/schemas/STime' ActorSource: title: ActorSource type: object description: describes the source of an actor properties: type: type: string example: oauth enum: - oauth - import - email - agent client_id: type: string x-go-custom-tag: dynamodbav:",omitempty" description: client ID if the resource was created via oauth2 app example: oczapier import_id: type: string x-go-custom-tag: dynamodbav:",omitempty" description: import ID if the resource was created by an import example: bf1b9f76-3f95-42fc-bd7f-050b2f5f4197 agent_id: type: string x-go-custom-tag: dynamodbav:",omitempty" description: agent ID if the resource was created by an agent example: bf1b9f76-3f95-42fc-bd7f-050b2f5f4197 email_addr: type: string x-go-custom-tag: dynamodbav:",omitempty" description: email address if the resource was created via an email example: somebody@example.com email_verified: type: boolean x-go-custom-tag: dynamodbav:",omitempty" description: whether the email sender was verified example: false on_behalf_of: type: string x-go-custom-tag: dynamodbav:",omitempty" description: >- User ID of the human responsible for this action. For trigger-initiated agent actions, this is the trigger creator. For mention/chat-initiated actions, this is the user who invoked the agent. securitySchemes: BearerAuth: type: http scheme: bearer ````