> ## 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 a space > Fetch comprehensive details about a specific project (referred to externally as a "Space") within a team (externally referred to as a "Workspace"). ## OpenAPI ````yaml GET /{team_id}/projects/{project_id} 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}/projects/{project_id}: parameters: - $ref: '#/components/parameters/path_team_id' - $ref: '#/components/parameters/path_project_id' get: tags: - Projects summary: Get a project description: > Fetch comprehensive details about a specific project (referred to externally as a "Space") within a team (externally referred to as a "Workspace"). operationId: getProject responses: '200': description: Project response content: application/json: schema: $ref: '#/components/schemas/GetProjectResponse' 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 path_project_id: in: path 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: GetProjectResponse: properties: project: $ref: '#/components/schemas/Project' 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' Project: type: object properties: id: type: string example: '421' team_id: type: string example: tDsu0j19 title: type: string example: My Project description: type: string icon: $ref: '#/components/schemas/Image' overview_page_id: type: string user_id: type: string example: u-dsu0j19 user_id_updated: type: string example: uDsu0j19 user: $ref: '#/components/schemas/Actor' user_updated: $ref: '#/components/schemas/Actor' time_created: $ref: '#/components/schemas/STime' time_updated: $ref: '#/components/schemas/STime' time_expires: $ref: '#/components/schemas/STime' members: type: array items: $ref: '#/components/schemas/Member' is_member: type: boolean description: true if currently logged in user is a member of this project example: true total_members: type: integer example: 7 x-omitempty: false total_members_online: type: integer example: 2 x-omitempty: false is_public: type: boolean description: Deprecated. Use is_private instead example: true x-omitempty: false is_private: type: boolean example: true x-omitempty: false page_order: type: array items: $ref: '#/components/schemas/FlatNode' pages: type: array items: $ref: '#/components/schemas/PageLink' x-omitempty: false trashed: $ref: '#/components/schemas/Trashed' archive_page_order: type: array items: $ref: '#/components/schemas/FlatNode' archive_pages: type: array items: $ref: '#/components/schemas/PageLink' x-omitempty: false board_order: $ref: '#/components/schemas/Order' boards: type: array items: $ref: '#/components/schemas/BoardLink' x-omitempty: false sprints: type: array items: $ref: '#/components/schemas/SprintLink' x-omitempty: false estimate_system: $ref: '#/components/schemas/EstimateSystem' is_view_only: type: boolean x-omitempty: true 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 Image: type: object required: - type - src properties: type: type: string enum: - image - icon - emoji nullable: false id: type: string description: Unique identifier for the image (optional). src: type: string example: >- data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg== description: >- Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name nullable: false blurhash: type: string example: LEHV6nWB2yk8pyoJadR*.7kCMdnj x-go-custom-tag: dynamodbav:",omitempty" color: type: string example: black x-go-custom-tag: dynamodbav:",omitempty" emoji: type: string example: thumbsup description: Emoji string ID x-go-custom-tag: dynamodbav:",omitempty" 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' Member: type: object properties: user_id: type: string example: u-dsu0j19 x-go-custom-tag: diff:"user_id,identifier" assigned_date: $ref: '#/components/schemas/STime' role: $ref: '#/components/schemas/MemberRole' FlatNode: type: object x-go-type: type: FlatNode import: package: github.com/superthread-com/common/pkg/types hints: noValidation: true kind: primitive nullable: true PageLink: type: object properties: id: type: string title: type: string icon: $ref: '#/components/schemas/Image' Trashed: type: object properties: user_deleted: $ref: '#/components/schemas/Actor' time_deleted: $ref: '#/components/schemas/STime' Order: type: object description: string array representing an order of IDs x-go-type: type: Order import: package: github.com/superthread-com/common/pkg/types hints: noValidation: true kind: primitive x-omitempty: true nullable: true BoardLink: type: object properties: id: type: string title: type: string SprintLink: type: object properties: id: type: string title: type: string start_date: $ref: '#/components/schemas/STime' end_date: $ref: '#/components/schemas/STime' EstimateSystem: type: string enum: - '' - fibonacci - exponential - tshirt 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. MemberRole: type: string enum: - admin - member - viewer securitySchemes: BearerAuth: type: http scheme: bearer ````