API
Issue spaces
Spaces, their settings, versions (releases) and components.
See Tasks.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/issues/spaces | Spaces the caller can browse (archived=1 includes archived ones). |
POST /v1/orgs/:orgId/issues/spaces | Creates a space from a template (scrum, kanban, bugs, service, basic) with its board; the caller becomes lead. |
GET /v1/orgs/:orgId/issues/spaces/:spaceKey | A space with what the caller may do in it, its versions and components. |
PATCH /v1/orgs/:orgId/issues/spaces/:spaceKey | Changes a space: name, key (old keys keep resolving), lead, and its configuration (types, workflows, screens, fields, access, security levels, notifications, service desk). |
PUT /v1/orgs/:orgId/issues/spaces/:spaceKey/email | Requests by email: links one of the org's Mail mailboxes to a service space (mailboxId null unlinks). New mail raises a request of requestTypeId; replies with [KEY-n] in the subject become comments. Needs the space's administer permission and the mailbox (as a member, or mail:admin). |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/archive | Archives a space: read-only and hidden from lists. |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/restore | Restores an archived space. |
DELETE /v1/orgs/:orgId/issues/spaces/:spaceKey | Deletes an archived space and everything in it, a batch at a time: call again while done is false. |
GET /v1/orgs/:orgId/issues/spaces/:spaceKey/versions | Versions (releases) of a space. |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/versions | Creates a version. |
GET /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId | A version with its issues and progress. |
PATCH /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId | Changes a version's name, dates, order or archived state. |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/release | Releases (or unreleases) a version, optionally moving unresolved issues to another version. |
GET /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/notes | Release notes in Markdown: resolved issues grouped by type. |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/deployments | Links (or unlinks) a Cloud deployment to a version. |
DELETE /v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId | Deletes a version, optionally moving its issues to replaceWith. |
GET /v1/orgs/:orgId/issues/spaces/:spaceKey/components | Components of a space. |
POST /v1/orgs/:orgId/issues/spaces/:spaceKey/components | Creates a component (with an optional lead and default assignee). |
PATCH /v1/orgs/:orgId/issues/spaces/:spaceKey/components/:componentId | Changes a component. |
DELETE /v1/orgs/:orgId/issues/spaces/:spaceKey/components/:componentId | Deletes a component and removes it from its issues. |