API
Issue tracking
Search, create, edit, transition, rank, link, comment on and log work on issues.
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/calendar/agenda | The caller's dates between from and to (YYYY-MM-DD, at most 100 days); tzOffset in minutes east of UTC dates sprint boundaries. |
POST /v1/orgs/:orgId/issues/calendar/schedule/:issueKey | Books time for an issue in one of the caller's Mail calendars (a mailbox they're a member of; its default calendar unless calendarId): the event links back to the issue, and the issue lists the event. Guests aren't invited. |
POST /v1/orgs/:orgId/issues/search | The same search as GET /issues with the query in the body (long queries). |
POST /v1/orgs/:orgId/issues/links/among | Links among up to 500 issues (by id), each once from its outward side: timeline dependencies. |
GET /v1/orgs/:orgId/issues | Searches with the query language (jql), paged. Default order: most recently updated. |
GET /v1/orgs/:orgId/issues/export | Issues matching a query as a CSV (Jira-style columns) or JSON download, up to 10,000. |
POST /v1/orgs/:orgId/issues/import | Imports a Jira CSV export (or this API's JSON export) into a space, 200 rows per call: pass startRow and keyMap from the previous answer until done. Space admins only. |
GET /v1/orgs/:orgId/issues/places | Places for an issue's location (docs/tasks/locations.md): up to 5 named like q (3 to 200 characters), nearest near (lat,lon) first. Shown to pick from, never kept: saving { address } looks the pick up again as a place to keep. Counts against the hour's address lookups (maps.places.searchHour); 429 past it. |
GET /v1/orgs/:orgId/issues/labels | Labels in use (most used first), for suggestions; space narrows to one space. |
POST /v1/orgs/:orgId/issues | Creates an issue. Catalog fields take names or ids, people take ids or emails, parent an issue key. |
POST /v1/orgs/:orgId/issues/rank | Reorders issues: puts them (in order) right before or after another issue. |
POST /v1/orgs/:orgId/issues/bulk | Runs one operation (edit, labels, transition, comment, move, delete, watch, unwatch) on up to 200 issues; each reports its own result. |
GET /v1/orgs/:orgId/issues/:issueKey | Everything the issue page shows: fields, description, comments, links, attachments, children, transitions. |
PATCH /v1/orgs/:orgId/issues/:issueKey | Edits fields (status changes go through transitions). |
DELETE /v1/orgs/:orgId/issues/:issueKey | Deletes an issue with its comments, attachments, work logs and subtasks. |
GET /v1/orgs/:orgId/issues/:issueKey/transitions | Transitions available from the issue's status, with the reason when a condition blocks one. |
POST /v1/orgs/:orgId/issues/:issueKey/transitions | Moves the issue through its workflow (by transition id or name, or the target status name). |
POST /v1/orgs/:orgId/issues/:issueKey/approvals/:approvalId | Approves or declines a service request as one of its approvers; a final decision moves it on. |
POST /v1/orgs/:orgId/issues/:issueKey/move | Moves the issue (and its subtasks) to another space under a new key; the old key keeps working. |
POST /v1/orgs/:orgId/issues/:issueKey/clone | Copies an issue (optionally with subtasks and links) and links the copy to the original. |
GET /v1/orgs/:orgId/issues/:issueKey/children | Child issues (subtasks, or stories of an epic). |
GET /v1/orgs/:orgId/issues/:issueKey/history | Field changes, newest first. |
GET /v1/orgs/:orgId/issues/:issueKey/comments | Comments, oldest first (order=desc for newest first). Internal comments only for agents. |
POST /v1/orgs/:orgId/issues/:issueKey/comments | Adds a comment (Markdown; mention people as @[Name](user:usr_…)). Internal comments are for service desk agents. |
PATCH /v1/orgs/:orgId/issues/:issueKey/comments/:commentId | Edits a comment (the previous body is kept as a revision) or changes its visibility. |
DELETE /v1/orgs/:orgId/issues/:issueKey/comments/:commentId | Deletes a comment. |
GET /v1/orgs/:orgId/issues/:issueKey/comments/:commentId/revisions | Earlier versions of an edited comment. |
POST /v1/orgs/:orgId/issues/:issueKey/comments/:commentId/reactions | Toggles the caller's reaction. |
GET /v1/orgs/:orgId/issues/:issueKey/links | Issue links and remote links (web pages, Notes pages, branches, commits, pull requests, deployments). |
POST /v1/orgs/:orgId/issues/:issueKey/links | Links to another issue by link type (id, name, or either direction's wording, e.g. "is blocked by"). |
DELETE /v1/orgs/:orgId/issues/:issueKey/links/:linkId | Removes a link from both issues. |
POST /v1/orgs/:orgId/issues/:issueKey/remote-links | Links a web page or Notes page. |
DELETE /v1/orgs/:orgId/issues/:issueKey/remote-links/:linkId | Removes a remote link. |
GET /v1/orgs/:orgId/issues/:issueKey/attachments | Attachments. |
POST /v1/orgs/:orgId/issues/:issueKey/attachments | Starts an upload: returns a presigned PUT (15 minutes, size and type signed). Finish with /complete. |
POST /v1/orgs/:orgId/issues/:issueKey/attachments/:attachmentId/complete | Finishes an upload once the file is in place. |
GET /v1/orgs/:orgId/issues/:issueKey/attachments/:attachmentId | A 5-minute download link (inline=1 opens images, PDFs and plain text in the browser). |
DELETE /v1/orgs/:orgId/issues/:issueKey/attachments/:attachmentId | Deletes an attachment and its file. |
GET /v1/orgs/:orgId/issues/:issueKey/worklogs | Work logs. |
POST /v1/orgs/:orgId/issues/:issueKey/worklogs | Logs work ("1h 30m" or seconds); the remaining estimate goes down unless told otherwise. |
PATCH /v1/orgs/:orgId/issues/:issueKey/worklogs/:worklogId | Changes a work log. |
DELETE /v1/orgs/:orgId/issues/:issueKey/worklogs/:worklogId | Deletes a work log (its time goes back on the remaining estimate). |
POST /v1/orgs/:orgId/issues/:issueKey/watchers | Starts or stops watching (the caller, or someone else with manage watchers). |
POST /v1/orgs/:orgId/issues/:issueKey/votes | Votes for an issue, or withdraws the vote. |