Skip to content

Main Navigation API Reference Data Models

Appearance

Sidebar Navigation

Getting Started

Introduction

Authentication

Sign In

Sign Up

Sign Out

Magic Link

OAuth

Password Management

Instance

Instance Config

Instance Admins

Workspace

List Workspaces

Create Workspace

Get Workspace

Update Workspace

Delete Workspace

Workspace Members

Workspace Invitations

Workspace Labels

Workspace States

Workspace Estimates

Draft Issues

Project

List Projects

Create Project

Get Project

Update Project

Delete Project

Project Members

Project Invitations

Project Deploy Boards

Project Archive

Issues

List Issues

Create Issue

Get Issue

Update Issue

Delete Issue

Issue Detail

Bulk Operations

Issue Relations

Issue Relations

Add Relation

Remove Relation

Issue Comments

List Comments

Create Comment

Update Comment

Delete Comment

Comment Reactions

Issue Attachments

List Attachments

Upload Attachment

Delete Attachment

Issue Links

List Links

Create Link

Delete Link

Sub-Issues

List Sub-Issues

Add Sub-Issue

Remove Sub-Issue

Issue Reactions

Issue Reactions

Add Reaction

Remove Reaction

Issue Subscribers

List Subscribers

Add Subscriber

Remove Subscriber

Issue Versions

Issue Versions

Description Versions

Issue Archive

Archive Issue

Deleted Issues

States

List States

Create State

Update State

Delete State

Mark Default

Labels

List Labels

Create Label

Update Label

Delete Label

Cycles

List Cycles

Create Cycle

Get Cycle

Update Cycle

Delete Cycle

Cycle Issues

Cycle Archive

Cycle Analytics

Cycle Progress

Modules

List Modules

Create Module

Get Module

Update Module

Delete Module

Module Issues

Module Archive

Pages

List Pages

Create Page

Get Page

Update Page

Delete Page

Page Archive

Page Lock/Unlock

Page Versions

Page Sub-Pages

Page Duplicate

Views

List Views

Create View

Update View

Delete View

Workspace Views

Intake / Inbox

List Intakes

Create Intake

Intake Issues

Update Intake Issue

Estimates

List Estimates

Create Estimate

Estimate Points

User

Get Current User

Update User

User Settings

User Profile

User Accounts

User Activities

User Workspaces

Notification Preferences

Notifications

List Notifications

Mark as Read

Mark All Read

Archive Notification

Webhooks

List Webhooks

Create Webhook

Update Webhook

Delete Webhook

Webhook Logs

API Tokens

List API Tokens

Create API Token

Delete API Token

Service API Tokens

Assets

List Assets

Upload Asset

Delete Asset

Favorites

List Favorites

Add Favorite

Remove Favorite

Search

Global Search

Search Issues

Entity Search

Analytics

Analytics

Saved Analytics Views

Export Analytics

External API v1

Overview

Projects

Issues

Cycles

Modules

States

Intake Issues

Public API

Overview

Public Issues

Public Comments

Public Project Meta

On this page

Get Workspace

GET/api/workspaces/{slug}/

Get detailed information about a specific workspace.

Path Parameters

Scopes

workspace:read

Edit this page

Pager

Previous pageCreate Workspace

Next pageUpdate Workspace