Kuayle API reference
Issues, comments, teams, projects, cycles, labels, views, wikis and webhooks over HTTP. Every Kuayle instance serves this API, and a personal access token is all a script, importer or integration needs to use it.
OpenAPI 3.1, Kuayle v0.2.40, 118 stable operations. This page is generated from the document that the backend's tests check against its routes and data types.
Your own instance serves the document for its release at /api/openapi.json.
On this page
- Authentication
- Token scopes
- Pagination
- Errors
- Rate limits
- Webhooks and signature verification
- Stability and versions
- Account endpoints
- Workspaces endpoints
- Members endpoints
- Teams endpoints
- Statuses endpoints
- Cycles endpoints
- Issues endpoints
- Comments endpoints
- Issue relations endpoints
- Labels endpoints
- Projects endpoints
- Views endpoints
- Wiki endpoints
- Webhooks endpoints
- Schemas
Authentication
Every request is authenticated with a personal access token. Create one in the app under Settings, API Tokens: choose its scopes, optionally limit it to some workspaces and give it an expiry date. The token is shown once and stored only as a hash.
Send the token in the Authorization header as "Bearer kuayle_pat_...". Use HTTPS; a token grants access until it expires or is revoked.
A token acts as the user who created it and never has more access than that user. Creating, listing and revoking tokens needs a signed-in browser session and is not possible with a token.
curl -H "Authorization: Bearer $KUAYLE_TOKEN" \
https://kuayle.example.com/api/workspacesToken scopes
Each operation names the scope it needs. A request passes when the token has that scope and the user's workspace role grants the same permission: scopes are a ceiling on the role, not an addition to it. Guests, for example, only read, whatever scopes their token carries.
A request without the needed scope or permission gets 403 FORBIDDEN. Private teams stay invisible to non-members: their issues, projects, cycles and wiki pages answer 404 or are left out of lists.
Scopes used by this reference:
- account:read
- comments:read
- cycle:manage
- cycles:read
- issue:create
- issue:delete
- issue:delete_own
- issue:update
- issues:read
- label:manage
- labels:read
- member:invite
- members:read
- project:manage
- projects:read
- team:manage
- teams:read
- view:manage
- views:read
- wiki:read
- wiki:write
- workspace:manage
- workspaces:read
Pagination
The issue list is paginated with the page and per_page query parameters (per_page defaults to 50 and should not exceed 100). The response wraps the items in data and adds total_count, page, per_page and has_more; request the next page while has_more is true.
The wiki registry and its overviews use a cursor: pass the next_before value of one response as before in the next request, and stop when next_before is null.
Every other list returns all items the user can see in one JSON array.
Errors
Errors use the HTTP status and one JSON shape: an error object with a machine-readable code, a message for people, and for validation errors a details array naming each field.
- 400 BAD_REQUEST: malformed JSON, an invalid ID, or a rule the request breaks; the message says which
- 400 VALIDATION_ERROR: one or more fields are invalid; see details
- 401 UNAUTHORIZED: the token is missing, unknown, expired or revoked
- 403 FORBIDDEN: the token's scopes, workspace limit or the user's role do not allow the request
- 404 NOT_FOUND: the resource does not exist or the user cannot see it
- 409 with a specific code such as CONFLICT or WIKI_VERSION_CONFLICT: the request conflicts with the current state
- 429 RATE_LIMITED: too many requests; wait for the number of seconds in the Retry-After header
- 500 INTERNAL_ERROR: the server failed; the request can be retried
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [{ "field": "Title", "message": "Title is required" }]
}
}Rate limits
Kuayle does not apply a request quota to authenticated API calls. Unauthenticated endpoints are limited per IP address: sign-in endpoints refill 5 requests per second with a burst of 10, and this document refills 10 per second with a burst of 20. A limited request gets 429 RATE_LIMITED with a Retry-After header.
The operator of an instance can add limits at the reverse proxy, so treat 429 as retryable everywhere: wait for Retry-After, then retry. Keep bulk jobs sequential or at low concurrency; the instance is shared with the people using the app.
Webhooks and signature verification
A webhook is a URL of yours registered for a workspace with a secret and a list of event names. The URL must be reachable from the instance and must not be a private, loopback or link-local address. The secret is stored encrypted and never returned.
A delivery is an HTTP POST with a JSON body holding event, payload and timestamp (RFC 3339, UTC). The X-Webhook-Event header repeats the event name. The X-Webhook-Signature header is "sha256=" followed by the hex HMAC-SHA256 of the raw request body, keyed with the webhook's secret. The X-Webhook-Delivery header is the delivery's id, the same in every attempt.
To verify a delivery, compute the same HMAC over the bytes you received, before parsing them, and compare it with the header in constant time. Reject the request when they differ. Deliveries time out after 10 seconds, so answer with a 2xx status quickly and do slow work afterwards.
Deliveries are sent after the change is saved: one per webhook subscribed to the event, and one per issue for bulk operations (bulk edits and deletes, unfinished issues moved to the next cycle). The issue in an issue event is the stored issue: its ids, identifier, title, description, status, priority, dates and timestamps, including started_at, completed_at, cancelled_at and triaged_at. actor_id is the user whose change caused the event, also for a follow-up Kuayle makes for them, such as closing a parent whose sub-issues are all done. It is null only for system automation: status transitions from forge and GitHub activity.
Delivery is at least once. Each change is stored when it is saved, one delivery per webhook, and survives restarts and updates of the instance; a delivery interrupted by a restart is sent again. A timeout, a network error or a status other than 2xx fails the attempt, and the delivery is retried with the same body, signature and X-Webhook-Delivery after 30 seconds, 2 minutes, 10 minutes, 30 minutes and 2 hours. After the sixth failed attempt, or once it has waited a day, it is given up. Use X-Webhook-Delivery to ignore a delivery you already handled. Each workspace has one delivery in flight at a time, workspaces take turns, and each workspace may hold at most 1024 pending deliveries and 8 MiB of payloads, and each webhook 256 deliveries, so a busy workspace or a dead receiver does not crowd out others; a delivery beyond these bounds is dropped. The webhook's delivery log (GET .../webhooks/{id}/deliveries) shows recent deliveries with their status, attempts, last status and error, and next attempt.
A webhook whose deliveries fail three times in a row is paused for five minutes: its deliveries wait while the workspace's other webhooks keep receiving theirs. After the pause the earliest due delivery is attempted; a success resumes the webhook and a failure pauses it again. A first attempt goes out in the order the changes were saved, but a retry arrives after later deliveries: do not rely on order. Compare payload.issue.updated_at (the envelope timestamp has one-second resolution), or fetch the issue again for its current state.
Webhooks are workspace-level and have no user, so they never deliver content of private teams: a workspace that has, or ever had, a private team does not deliver webhooks at all, creating or enabling a webhook there is refused with 403 PRIVATE_WORKSPACE_OPERATION_DISABLED, and a stored delivery is checked again when it is sent. Changes the database makes by itself send no event: deleting a parent detaches its sub-issues, deleting a project or cycle clears it from its issues, deleting a team deletes its issues and renaming a team key changes identifiers. A workspace import sends none either. Kuayle delivers these events:
comment.created: A comment was posted on an issue. The payload holds the comment and the issue's id, identifier and team_id. See Webhooks and signature verification. Body: CommentEventDelivery.comment.deleted: A comment was deleted by a workspace admin or owner. The payload is that of comment.created, with the comment as it was when it was deleted; its replies are hidden with it and send no deliveries of their own. Restoring the comment within the grace period sends no event. See Webhooks and signature verification. Body: CommentEventDelivery.comment.updated: A comment was resolved, reopened or edited by its author. The payload is that of comment.created, with the comment as stored after the change; an edit sets edited_at. Resolving a resolved comment, reopening an open one or saving an unchanged body sends nothing. See Webhooks and signature verification. Body: CommentEventDelivery.issue.created: An issue was created, including sub-issues and duplicates. A workspace import does not send it. See Webhooks and signature verification. Body: IssueEventDelivery.issue.deleted: An issue was deleted. The payload holds the issue as it was when it was deleted. A bulk delete sends one delivery per issue; issues deleted with their team send none. See Webhooks and signature verification. Body: IssueEventDelivery.issue.triaged: An issue was accepted or declined from triage. Declining also moves it to cancelled: that is part of this event, not a separate issue.updated. See Webhooks and signature verification. Body: IssueEventDelivery.issue.updated: An issue changed: a field, its status, assignees, labels, project, parent or cycle, including bulk edits, unfinished issues moved to the next cycle and automation. A bulk operation sends one delivery per issue. Changes the database makes by itself, such as clearing a deleted project, cycle or parent, send none. See Webhooks and signature verification. Body: IssueEventDelivery.
import { createHmac, timingSafeEqual } from 'node:crypto';
// rawBody: the request body bytes exactly as received, before any JSON parsing.
export function isFromKuayle(rawBody, signatureHeader, secret) {
const expected = 'sha256=' + createHmac('sha256', secret).update(rawBody).digest('hex');
const received = Buffer.from(signatureHeader ?? '');
return received.length === expected.length && timingSafeEqual(received, Buffer.from(expected));
}Stability and versions
This document lists the stable operations. Its version is the Kuayle release it was built from, and each instance serves the document for its own release at /api/openapi.json. Changes to a stable operation ship with a release and are listed in its notes.
Routes of the app that are not listed here are internal: they serve the web app, the dev machines or integration setup, may change in any release, and most reject tokens.
Endpoints
Paths are relative to your instance and already include /api. Each endpoint lists
the token scope it needs, its parameters, and the schemas of its request and response.
Account
The user a token belongs to.
Get the token's user
GET /api/auth/me
Returns the user who owns the token. Use it to check that a token works.
- Scope:
account:read- Response 200:
- User
- Errors:
- 401, 403, 429 (error format)
Workspaces
Workspaces the user belongs to. Most paths start with a workspace slug.
List workspaces
GET /api/workspaces
Lists the workspaces the user belongs to. A token limited to some workspaces lists only those.
- Scope:
workspaces:read- Response 200:
- array of Workspace
- Errors:
- 401, 403, 429 (error format)
Get a workspace
GET /api/workspaces/{slug}
- Scope:
workspaces:read- Response 200:
- Workspace
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Members
People in a workspace and their roles: owner, admin, member or guest.
Add an existing user to the workspace
POST /api/workspaces/{slug}/invite
Adds a registered user by email with the given role.
- Scope:
member:invite- Request body:
- InviteMemberRequest
- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
List workspace members
GET /api/workspaces/{slug}/members
- Scope:
members:read- Response 200:
- array of WorkspaceMember
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Change a member's role
PATCH /api/workspaces/{slug}/members/{userId}
- Scope:
member:invite- Request body:
- UpdateMemberRoleRequest
- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.userId(path, string (uuid), required) User ID.
Remove a member from the workspace
DELETE /api/workspaces/{slug}/members/{userId}
- Scope:
member:invite- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.userId(path, string (uuid), required) User ID.
Teams
Teams own issues, statuses and cycles. Private teams are visible to their members, owners and admins.
List teams
GET /api/workspaces/{slug}/teams
Lists the teams the user can see. Private teams appear only for their members, owners and admins.
- Scope:
teams:read- Response 200:
- array of Team
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Create a team
POST /api/workspaces/{slug}/teams
- Scope:
team:manage- Request body:
- CreateTeamRequest
- Response 201:
- Team
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Get a team
GET /api/workspaces/{slug}/teams/{teamId}
- Scope:
teams:read- Response 200:
- Team
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Update a team
PATCH /api/workspaces/{slug}/teams/{teamId}
- Scope:
team:manage- Request body:
- UpdateTeamRequest
- Response 200:
- Team
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Delete a team
DELETE /api/workspaces/{slug}/teams/{teamId}
- Scope:
team:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
List team members
GET /api/workspaces/{slug}/teams/{teamId}/members
- Scope:
members:readandteams:read- Response 200:
- array of TeamMember
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Add a workspace member to a team
POST /api/workspaces/{slug}/teams/{teamId}/members
- Scope:
team:manage- Request body:
- AddTeamMemberRequest
- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Remove a member from a team
DELETE /api/workspaces/{slug}/teams/{teamId}/members/{userId}
- Scope:
team:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.userId(path, string (uuid), required) User ID.
Make a team private or public
PATCH /api/workspaces/{slug}/teams/{teamId}/visibility
- Scope:
team:manage- Request body:
- SetTeamVisibilityRequest
- Response 200:
- Team
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Statuses
A team's workflow statuses, each in one category: backlog, unstarted, started, completed or cancelled.
List a team's statuses
GET /api/workspaces/{slug}/teams/{teamId}/statuses
Statuses are the team's workflow, ordered by position. Use a status ID as status_id when writing issues.
- Scope:
teams:read- Response 200:
- array of TeamStatus
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Create a status
POST /api/workspaces/{slug}/teams/{teamId}/statuses
- Scope:
team:manage- Request body:
- CreateTeamStatusRequest
- Response 201:
- TeamStatus
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Update a status
PATCH /api/workspaces/{slug}/teams/{teamId}/statuses/{statusId}
- Scope:
team:manage- Request body:
- UpdateTeamStatusRequest
- Response 200:
- TeamStatus
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.statusId(path, string (uuid), required) Status ID.
Delete a status
DELETE /api/workspaces/{slug}/teams/{teamId}/statuses/{statusId}
- Scope:
team:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.statusId(path, string (uuid), required) Status ID.
Cycles
Date-bound iterations of a team. Tokens read cycles; they are changed in the app.
List a team's cycles
GET /api/workspaces/{slug}/teams/{teamId}/cycles
Each cycle carries its progress counts.
- Scope:
cycles:read- Response 200:
- array of Cycle
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Create a cycle
POST /api/workspaces/{slug}/teams/{teamId}/cycles
- Scope:
cycle:manage- Request body:
- CreateCycleRequest
- Response 201:
- Cycle
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Get velocity across a team's cycles
GET /api/workspaces/{slug}/teams/{teamId}/cycles/velocity
- Scope:
cycles:read- Response 200:
- array of VelocityPoint
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Get a cycle
GET /api/workspaces/{slug}/teams/{teamId}/cycles/{cycleId}
- Scope:
cycles:read- Response 200:
- Cycle
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.cycleId(path, string (uuid), required) Cycle ID.
Update a cycle
PATCH /api/workspaces/{slug}/teams/{teamId}/cycles/{cycleId}
- Scope:
cycle:manage- Request body:
- UpdateCycleRequest
- Response 200:
- Cycle
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.cycleId(path, string (uuid), required) Cycle ID.
Delete a cycle
DELETE /api/workspaces/{slug}/teams/{teamId}/cycles/{cycleId}
- Scope:
cycle:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.cycleId(path, string (uuid), required) Cycle ID.
Get a cycle's burndown
GET /api/workspaces/{slug}/teams/{teamId}/cycles/{cycleId}/burndown
- Scope:
cycles:read- Response 200:
- array of BurndownPoint
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.cycleId(path, string (uuid), required) Cycle ID.
Complete a cycle
POST /api/workspaces/{slug}/teams/{teamId}/cycles/{cycleId}/complete
Optionally carries unfinished issues over to the next upcoming cycle.
- Scope:
cycle:manage- Request body:
- CompleteCycleRequest
- Response 200:
- CompleteCycleResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.cycleId(path, string (uuid), required) Cycle ID.
Issues
Issues are addressed by identifier, for example ENG-42.
List issues
GET /api/workspaces/{slug}/issues
Returns one page of the issues the user can see, with filters and sorting. See Pagination.
- Scope:
issues:read- Response 200:
- IssueList
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.page(query, integer) Page number, starting at 1. 1 to anyper_page(query, integer) Items per page. Defaults to 50. 1 to 100status(query, string) Comma-separated legacy status names or status IDs.status_type(query, string) Status category: backlog, unstarted, started, completed or cancelled.priority(query, string) Comma-separated priorities, 0 (none) to 4.assignee(query, string) User ID or agent ID, or "none" for issues assigned to nobody.creator(query, string) User ID of the creator.agent_assigned_by(query, string) User ID: issues with an AI agent that this user assigned.team(query, string) Team ID.project(query, string) Project ID, or "none" for issues without a project.cycle(query, string) Cycle ID, or "none" for issues without a cycle.label(query, string) Label ID, or "none" for issues without labels.search(query, string) Text matched against the issue title and identifier and the team name, key and description.due_before(query, string) Only issues due on or before this date (YYYY-MM-DD).due_after(query, string) Only issues due on or after this date (YYYY-MM-DD).triaged(query, string) "false" for issues waiting in triage, any other value for triaged issues.sub_issues(query, string) "exclude" or "top_level" for issues without a parent, "only" for sub-issues, "has_sub_issues" for parents.parent_id(query, string) Parent issue ID, or "none" for issues without a parent.group_by(query, string) Orders the result so that issues of one group are adjacent. one of status, priority, assignee, projectsort(query, string) Sort field. Defaults to created_at. one of created_at, updated_at, priority, sort_order, status, due_dateorder(query, string) Sort direction. one of asc, descstatus_category_order(query, string) With group_by=status, a comma-separated order of status categories.
Create an issue
POST /api/workspaces/{slug}/issues
Creates an issue in a team. The description is Markdown or editor HTML and is sanitized. In a team with triage enabled the issue waits in triage.
- Scope:
issue:create- Request body:
- CreateIssueRequest
- Response 201:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Update several issues
PATCH /api/workspaces/{slug}/issues/bulk
The response carries an undo for POST /issues/bulk/undo when the change can be undone (all fields but parent_id).
- Scope:
issue:update- Request body:
- BulkUpdateIssueRequest
- Response 200:
- BulkUpdateIssue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Delete several issues
DELETE /api/workspaces/{slug}/issues/bulk
Members delete only issues they created; owners and admins delete any.
- Scope:
issue:delete_own- Request body:
- BulkDeleteIssueRequest
- Response 200:
- BulkDeleteIssue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Restore several deleted issues
POST /api/workspaces/{slug}/issues/bulk/restore
Members restore only issues they created; owners and admins restore any. A deleted issue can be restored until its grace period ends (ISSUE_DELETE_GRACE_PERIOD, 30 days by default); after that the response is 410 GRACE_EXPIRED, and once purged the issue is not found.
- Scope:
issue:delete_own- Request body:
- BulkRestoreIssueRequest
- Response 200:
- BulkRestoreIssue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Undo a bulk update
POST /api/workspaces/{slug}/issues/bulk/undo
Sends back the undo of a bulk update response. Applies to every issue or none: if any issue changed since (its version differs), nothing is undone.
- Scope:
issue:update- Request body:
- BulkIssueUndoInput
- Response 200:
- BulkUndoIssue
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Get an issue
GET /api/workspaces/{slug}/issues/{identifier}
- Scope:
issues:read- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Update an issue
PATCH /api/workspaces/{slug}/issues/{identifier}
Changes the fields that are present.
- Scope:
issue:update- Request body:
- UpdateIssueRequest
- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Delete an issue
DELETE /api/workspaces/{slug}/issues/{identifier}
Members delete only issues they created; owners and admins delete any. The issue can be restored until restorable_until.
- Scope:
issue:delete_own- Response 200:
- DeleteIssue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Convert an issue to a project
POST /api/workspaces/{slug}/issues/{identifier}/convert-to-project
- Scope:
project:manage- Response 201:
- ConvertIssueToProject
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Duplicate an issue
POST /api/workspaces/{slug}/issues/{identifier}/duplicate
- Scope:
issue:create- Request body:
- DuplicateIssueRequest
- Response 201:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Get an issue's change history
GET /api/workspaces/{slug}/issues/{identifier}/history
- Scope:
issues:read- Response 200:
- array of IssueHistory
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Restore a deleted issue
POST /api/workspaces/{slug}/issues/{identifier}/restore
Members restore only issues they created; owners and admins restore any. A deleted issue can be restored until its grace period ends (ISSUE_DELETE_GRACE_PERIOD, 30 days by default); after that the response is 410 GRACE_EXPIRED, and once purged the issue is not found.
- Scope:
issue:delete_own- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
List an issue's sub-issues
GET /api/workspaces/{slug}/issues/{identifier}/sub-issues
- Scope:
issues:read- Response 200:
- array of Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Create a sub-issue
POST /api/workspaces/{slug}/issues/{identifier}/sub-issues
- Scope:
issue:create- Request body:
- CreateSubIssueRequest
- Response 201:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Create several sub-issues
POST /api/workspaces/{slug}/issues/{identifier}/sub-issues/bulk
- Scope:
issue:create- Request body:
- BulkCreateSubIssueRequest
- Response 201:
- array of Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Accept an issue from triage
POST /api/workspaces/{slug}/issues/{identifier}/triage/accept
- Scope:
issue:update- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Decline an issue in triage
POST /api/workspaces/{slug}/issues/{identifier}/triage/decline
- Scope:
issue:update- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Undo an issue update
POST /api/workspaces/{slug}/issues/{identifier}/undo
Sends back the undo of an update response to put the previous values back. If the issue changed since (its version differs), nothing is undone.
- Scope:
issue:update- Request body:
- IssueUndoInput
- Response 200:
- Issue
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Comments
Threaded comments on an issue.
List an issue's comments
GET /api/workspaces/{slug}/issues/{identifier}/comments
Returns top-level comments, each with its replies.
- Scope:
comments:read- Response 200:
- array of Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Add a comment to an issue
POST /api/workspaces/{slug}/issues/{identifier}/comments
The body is Markdown or editor HTML and is sanitized. Set parent_id to reply to a comment.
- Scope:
issue:create- Request body:
- CreateCommentRequest
- Response 201:
- Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Edit a comment
PATCH /api/workspaces/{slug}/issues/{identifier}/comments/{commentId}
Only the comment's author can edit it; anyone else, admins included, gets 403. The body is Markdown or editor HTML and is sanitized. A changed body sets edited_at and sends comment.updated.
- Scope:
issue:create- Request body:
- UpdateCommentRequest
- Response 200:
- Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.commentId(path, string (uuid), required) Comment ID.
Delete a comment
DELETE /api/workspaces/{slug}/issues/{identifier}/comments/{commentId}
Workspace admins and owners only. The comment and its replies are hidden and stay restorable until restorable_until, the same grace period as deleted issues. Sends comment.deleted.
- Scope:
issue:delete- Response 200:
- DeleteComment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.commentId(path, string (uuid), required) Comment ID.
Reopen a comment thread
POST /api/workspaces/{slug}/issues/{identifier}/comments/{commentId}/reopen
- Scope:
issue:update- Response 200:
- Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.commentId(path, string (uuid), required) Comment ID.
Resolve a comment thread
POST /api/workspaces/{slug}/issues/{identifier}/comments/{commentId}/resolve
- Scope:
issue:update- Response 200:
- Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.commentId(path, string (uuid), required) Comment ID.
Restore a deleted comment
POST /api/workspaces/{slug}/issues/{identifier}/comments/{commentId}/restore
Workspace admins and owners only. Brings back a comment deleted within the grace period, with its replies; past it the response is 410 GRACE_EXPIRED. Sends no webhook.
- Scope:
issue:delete- Response 200:
- Comment
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.commentId(path, string (uuid), required) Comment ID.
Issue relations
Links between issues: related, blocked_by, blocking or duplicate.
List an issue's relations
GET /api/workspaces/{slug}/issues/{identifier}/relations
- Scope:
issues:read- Response 200:
- array of IssueRelation
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Relate two issues
POST /api/workspaces/{slug}/issues/{identifier}/relations
- Scope:
issue:update- Request body:
- CreateIssueRelationRequest
- Response 201:
- IssueRelation
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Remove a relation
DELETE /api/workspaces/{slug}/issues/{identifier}/relations/{relationId}
- Scope:
issue:update- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.relationId(path, string (uuid), required) Relation ID.
Labels
Workspace and project labels.
List labels
GET /api/workspaces/{slug}/labels
- Scope:
labels:read- Response 200:
- array of Label
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.project_id(query, string (uuid)) Return workspace labels and the labels of this project only.
Create a label
POST /api/workspaces/{slug}/labels
- Scope:
label:manage- Request body:
- CreateLabelRequest
- Response 201:
- Label
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Update a label
PATCH /api/workspaces/{slug}/labels/{id}
- Scope:
label:manage- Request body:
- UpdateLabelRequest
- Response 200:
- Label
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Delete a label
DELETE /api/workspaces/{slug}/labels/{id}
- Scope:
label:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Projects
Projects group issues across teams.
List projects
GET /api/workspaces/{slug}/projects
Each project carries its progress counts.
- Scope:
projects:read- Response 200:
- array of Project
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Create a project
POST /api/workspaces/{slug}/projects
- Scope:
project:manage- Request body:
- CreateProjectRequest
- Response 201:
- Project
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Get a project
GET /api/workspaces/{slug}/projects/{id}
- Scope:
projects:read- Response 200:
- Project
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Update a project
PATCH /api/workspaces/{slug}/projects/{id}
- Scope:
project:manage- Request body:
- UpdateProjectRequest
- Response 200:
- Project
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Delete a project
DELETE /api/workspaces/{slug}/projects/{id}
- Scope:
project:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
List a team's projects
GET /api/workspaces/{slug}/teams/{teamId}/projects
- Scope:
projects:read- Response 200:
- array of Project
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Views
Saved issue filters. Tokens read views; they are changed in the app.
List saved views
GET /api/workspaces/{slug}/views
Lists the user's own views and the views shared with the workspace.
- Scope:
views:read- Response 200:
- array of View
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Create a saved view
POST /api/workspaces/{slug}/views
- Scope:
view:manage- Request body:
- CreateViewRequest
- Response 201:
- View
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Get a saved view
GET /api/workspaces/{slug}/views/{id}
- Scope:
views:read- Response 200:
- View
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Update a saved view
PATCH /api/workspaces/{slug}/views/{id}
Only the creator can change a view.
- Scope:
view:manage- Request body:
- UpdateViewRequest
- Response 200:
- View
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Delete a saved view
DELETE /api/workspaces/{slug}/views/{id}
Only the creator can delete a view.
- Scope:
view:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Wiki
Pages of a team's or a project's wiki, with version history, a tree, a dated registry and publication.
List the wiki pages attached to an issue
GET /api/workspaces/{slug}/issues/{identifier}/wiki-references
Pages the caller cannot see are returned with accessible false and no title.
- Scope:
issues:readandwiki:read- Response 200:
- array of WikiReference
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Attach a wiki page to an issue
POST /api/workspaces/{slug}/issues/{identifier}/wiki-references
Returns the issue's attached pages.
- Scope:
issue:updateandwiki:read- Request body:
- AttachWikiReferenceRequest
- Response 200:
- array of WikiReference
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.
Remove a wiki page from an issue
DELETE /api/workspaces/{slug}/issues/{identifier}/wiki-references/{pageId}
- Scope:
issue:update- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.identifier(path, string, required) Issue identifier: the team key and issue number, for example ENG-42.pageId(path, string (uuid), required) Wiki page ID.
List the pages of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki
Pages are returned without their content. With search, only pages whose title or text contains it.
- Scope:
wiki:read- Response 200:
- array of WikiPageSummary
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.search(query, string) Text to find in the title or the text of a page, ignoring case.
Create a page in a project wiki
POST /api/workspaces/{slug}/projects/{id}/wiki
Content is Markdown or editor HTML and is sanitized.
- Scope:
wiki:write- Request body:
- CreateWikiPageRequest
- Response 201:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Read the registry of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki/registry
The registry is a dated log, one page per UTC day, newest first.
- Scope:
wiki:read- Response 200:
- WikiRegistryFeed
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.before(query, string (date)) Return entries older than this value; pass next_before from the previous response.limit(query, integer) Days to return, 1 to 31. Defaults to 7.
Add an entry to today's registry page of a project wiki
POST /api/workspaces/{slug}/projects/{id}/wiki/registry
- Scope:
wiki:write- Request body:
- WikiRegistryRequest
- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
List the registry overviews of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki/registry/overviews
- Scope:
wiki:read- Response 200:
- WikiOverviewList
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.before(query, string (date-time)) Return entries older than this value; pass next_before from the previous response.limit(query, integer) Overviews to return, 1 to 50. Defaults to 10.
Get the settings of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki/settings
- Scope:
wiki:read- Response 200:
- WikiSettings
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Update the settings of a project wiki
PATCH /api/workspaces/{slug}/projects/{id}/wiki/settings
- Scope:
wiki:write- Request body:
- WikiSettingsRequest
- Response 200:
- WikiSettings
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Get the page tree of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki/tree
Lists each page's parent, position and kind (page or folder).
- Scope:
wiki:read- Response 200:
- array of WikiTreeNode
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Create a page or folder under a parent in a project wiki
POST /api/workspaces/{slug}/projects/{id}/wiki/tree
- Scope:
wiki:write- Request body:
- CreateWikiTreePageRequest
- Response 201:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Get a page of a project wiki
GET /api/workspaces/{slug}/projects/{id}/wiki/{pageId}
- Scope:
wiki:read- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Update a page of a project wiki
PATCH /api/workspaces/{slug}/projects/{id}/wiki/{pageId}
Send the version you read; a stale version is rejected so concurrent edits are not lost.
- Scope:
wiki:write- Request body:
- UpdateWikiPageRequest
- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Delete a page of a project wiki
DELETE /api/workspaces/{slug}/projects/{id}/wiki/{pageId}
Its child pages move up to its parent. The page can be restored until restorable_until.
- Scope:
wiki:write- Response 200:
- DeleteWikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
List where a project wiki page is referenced
GET /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/backlinks
Issues that mention the page in their description or a comment or have it attached, and pages that mention it, limited to what the caller can see. The issues are listed only with issues:read.
- Scope:
wiki:read- Response 200:
- WikiBacklinks
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Move a page within a project wiki
POST /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/move
Returns the new tree.
- Scope:
wiki:write- Request body:
- MoveWikiPageRequest
- Response 200:
- array of WikiTreeNode
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Get how a project wiki page is published
GET /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/publish
- Scope:
wiki:read- Response 200:
- WikiPublication
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Publish or unpublish a project wiki page
PUT /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/publish
Mode is off, internal or public. Only roles allowed by the workspace may publish publicly.
- Scope:
wiki:write- Request body:
- WikiPublishRequest
- Response 200:
- WikiPublication
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
Restore a deleted page of a project wiki
POST /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/restore
Within the grace period (ISSUE_DELETE_GRACE_PERIOD, 30 days by default) the page comes back under its parent, or at the top level if the parent is gone; after it the response is 410 GRACE_EXPIRED.
- Scope:
wiki:write- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
List the earlier versions of a project wiki page
GET /api/workspaces/{slug}/projects/{id}/wiki/{pageId}/versions
- Scope:
wiki:read- Response 200:
- array of WikiRevision
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.pageId(path, string (uuid), required) Wiki page ID.
List the pages of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki
Pages are returned without their content. With search, only pages whose title or text contains it.
- Scope:
wiki:read- Response 200:
- array of WikiPageSummary
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.search(query, string) Text to find in the title or the text of a page, ignoring case.
Create a page in a team wiki
POST /api/workspaces/{slug}/teams/{teamId}/wiki
Content is Markdown or editor HTML and is sanitized.
- Scope:
wiki:write- Request body:
- CreateWikiPageRequest
- Response 201:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Read the registry of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki/registry
The registry is a dated log, one page per UTC day, newest first.
- Scope:
wiki:read- Response 200:
- WikiRegistryFeed
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.before(query, string (date)) Return entries older than this value; pass next_before from the previous response.limit(query, integer) Days to return, 1 to 31. Defaults to 7.
Add an entry to today's registry page of a team wiki
POST /api/workspaces/{slug}/teams/{teamId}/wiki/registry
- Scope:
wiki:write- Request body:
- WikiRegistryRequest
- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
List the registry overviews of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki/registry/overviews
- Scope:
wiki:read- Response 200:
- WikiOverviewList
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.before(query, string (date-time)) Return entries older than this value; pass next_before from the previous response.limit(query, integer) Overviews to return, 1 to 50. Defaults to 10.
Get the settings of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki/settings
- Scope:
wiki:read- Response 200:
- WikiSettings
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Update the settings of a team wiki
PATCH /api/workspaces/{slug}/teams/{teamId}/wiki/settings
- Scope:
wiki:write- Request body:
- WikiSettingsRequest
- Response 200:
- WikiSettings
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Get the page tree of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki/tree
Lists each page's parent, position and kind (page or folder).
- Scope:
wiki:read- Response 200:
- array of WikiTreeNode
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Create a page or folder under a parent in a team wiki
POST /api/workspaces/{slug}/teams/{teamId}/wiki/tree
- Scope:
wiki:write- Request body:
- CreateWikiTreePageRequest
- Response 201:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.
Get a page of a team wiki
GET /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}
- Scope:
wiki:read- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Update a page of a team wiki
PATCH /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}
Send the version you read; a stale version is rejected so concurrent edits are not lost.
- Scope:
wiki:write- Request body:
- UpdateWikiPageRequest
- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Delete a page of a team wiki
DELETE /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}
Its child pages move up to its parent. The page can be restored until restorable_until.
- Scope:
wiki:write- Response 200:
- DeleteWikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
List where a team wiki page is referenced
GET /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/backlinks
Issues that mention the page in their description or a comment or have it attached, and pages that mention it, limited to what the caller can see. The issues are listed only with issues:read.
- Scope:
wiki:read- Response 200:
- WikiBacklinks
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Move a page within a team wiki
POST /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/move
Returns the new tree.
- Scope:
wiki:write- Request body:
- MoveWikiPageRequest
- Response 200:
- array of WikiTreeNode
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Get how a team wiki page is published
GET /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/publish
- Scope:
wiki:read- Response 200:
- WikiPublication
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Publish or unpublish a team wiki page
PUT /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/publish
Mode is off, internal or public. Only roles allowed by the workspace may publish publicly.
- Scope:
wiki:write- Request body:
- WikiPublishRequest
- Response 200:
- WikiPublication
- Errors:
- 400, 401, 403, 404, 409, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Restore a deleted page of a team wiki
POST /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/restore
Within the grace period (ISSUE_DELETE_GRACE_PERIOD, 30 days by default) the page comes back under its parent, or at the top level if the parent is gone; after it the response is 410 GRACE_EXPIRED.
- Scope:
wiki:write- Response 200:
- WikiPage
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
List the earlier versions of a team wiki page
GET /api/workspaces/{slug}/teams/{teamId}/wiki/{pageId}/versions
- Scope:
wiki:read- Response 200:
- array of WikiRevision
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.teamId(path, string (uuid), required) Team ID.pageId(path, string (uuid), required) Wiki page ID.
Search wiki pages to reference
GET /api/workspaces/{slug}/wiki/references
Pages of every team and project the caller can see, most recently updated first.
- Scope:
wiki:read- Response 200:
- array of WikiReference
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.q(query, string) Text the page title contains.limit(query, integer) Pages to return, 1 to 20.
Resolve wiki page references
POST /api/workspaces/{slug}/wiki/references/resolve
Answers every requested page ID: with title and team or project when the caller can see the page, and with accessible false otherwise.
- Scope:
wiki:read- Request body:
- ResolveWikiReferencesRequest
- Response 200:
- array of WikiReference
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Webhooks
Signed HTTP callbacks for a workspace. See Webhooks and signature verification.
List webhooks
GET /api/workspaces/{slug}/webhooks
The signing secret is never returned.
- Scope:
workspace:manage- Response 200:
- array of Webhook
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Create a webhook
POST /api/workspaces/{slug}/webhooks
The URL must be public: private, loopback and link-local addresses are rejected. The secret is stored encrypted and signs every delivery. A workspace that has or had a private team delivers no webhooks: there it answers 403 PRIVATE_WORKSPACE_OPERATION_DISABLED.
- Scope:
workspace:manage- Request body:
- CreateWebhookRequest
- Response 201:
- Webhook
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.
Update a webhook
PATCH /api/workspaces/{slug}/webhooks/{id}
Fields left out are unchanged. events, when sent, must list at least one event, and a changed list may name only issue.created, issue.updated, issue.deleted, issue.triaged, comment.created, comment.updated and comment.deleted. The webhook's stored list sent back unchanged is accepted even when it names an event Kuayle no longer delivers. Enabling an inactive webhook is refused the same way as creating one; disabling, editing and deleting still work. A workspace that has or had a private team delivers no webhooks: there it answers 403 PRIVATE_WORKSPACE_OPERATION_DISABLED.
- Scope:
workspace:manage- Request body:
- UpdateWebhookRequest
- Response 200:
- Webhook
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Delete a webhook
DELETE /api/workspaces/{slug}/webhooks/{id}
- Scope:
workspace:manage- Response 200:
- StatusResult
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
List a webhook's recent deliveries
GET /api/workspaces/{slug}/webhooks/{id}/deliveries
The 50 most recent deliveries, newest first: pending, delivered or failed, with the attempts made, the last HTTP status and error code, and the next attempt of a pending one. Finished deliveries are kept for seven days. Payloads and the URL are not returned.
- Scope:
workspace:manage- Response 200:
- array of WebhookDelivery
- Errors:
- 400, 401, 403, 404, 429 (error format)
Parameters
slug(path, string, required) Workspace slug, as in the app's URLs.id(path, string (uuid), required) Resource ID.
Schemas
The JSON objects the endpoints accept and return. Required fields of a request must be sent; required fields of a response are always present. A field marked "or null" may hold null.
AddTeamMemberRequest
user_idstring (uuid), required
AttachWikiReferenceRequest
page_idstring
BulkCreateSubIssueRequest
issuesarray of CreateSubIssueRequest, required; at least 1 item
BulkDeleteIssue
deletedinteger, requiredrestorable_untilstring (date-time), required
BulkDeleteIssueRequest
issue_idsarray of string (uuid), required; at least 1 item
BulkIssueUndo
itemsarray of BulkIssueUndoItem, required; at least 1 item; at most 5000 items
BulkIssueUndoInput
itemsarray of BulkIssueUndoItemInput, required; at least 1 item; at most 5000 items
BulkIssueUndoItem
expected_versioninteger, required; 1 to anyidstring (uuid), requiredpreviousIssueUndoPrevious, required
BulkIssueUndoItemInput
expected_versioninteger; 1 to anyidstring (uuid), requiredpreviousIssueUndoPreviousInput
BulkRestoreIssue
restoredinteger, required
BulkRestoreIssueRequest
issue_idsarray of string (uuid), required; at least 1 item; at most 5000 items
BulkUndoIssue
updatedinteger, required
BulkUpdateIssue
undoBulkIssueUndoupdatedinteger, required
BulkUpdateIssueRequest
assignee_idstring (uuid) or nullcycle_idstring or nullissue_idsarray of string (uuid), required; at least 1 itemlabel_idsarray of string (uuid)parent_idstring or nullpriorityinteger or null; 0 to 4project_idstring or nullstatusstring or null; one of backlog, todo, in_progress, in_review, done, cancelledstatus_idstring (uuid) or null
BurndownPoint
completedinteger, requireddatestring, requiredscopeinteger, requiredstartedinteger, required
Comment
CommentEventDelivery
eventstring, required; one of comment.created, comment.updated, comment.deletedpayloadWebhookCommentPayload, requiredtimestampstring, required
CompleteCycleRequest
carry_overbooleanretrospectivestring or null
CompleteCycleResult
carried_over_countinteger, requiredcycleCycle, required
ConvertIssueToProject
projectProject, required
CreateCommentRequest
bodystring, required; length 1 to anyparent_idstring (uuid) or null
CreateCycleRequest
descriptionstring or nullend_datestring, requiredgoalsstring or nullnamestring, required; length 1 to 100start_datestring, required
CreateIssueRelationRequest
related_identifierstring, requiredtypestring, required; one of related, blocked_by, blocking, duplicate
CreateIssueRequest
assignee_idstring (uuid) or nullassignee_idsarray of string (uuid)cycle_idstring (uuid) or nulldescriptionstring or nulldue_datestring or nulllabel_idsarray of string (uuid)parent_idstring (uuid) or nullpriorityinteger or null; 0 to 4project_idstring (uuid) or nullstatusstring; length 0 to 100status_idstring (uuid) or nullteam_idstring (uuid), requiredtitlestring, required; length 1 to 500
CreateLabelRequest
colorstring, requireddescriptionstring or nullnamestring, required; length 1 to 50parent_idstring (uuid) or nullproject_idstring (uuid) or null
CreateProjectRequest
colorstring or null; length 0 to 7descriptionstring or nulliconstring or null; length 0 to 50lead_idstring (uuid) or nullnamestring, required; length 1 to 200start_datestring or nulltarget_datestring or nullteam_idstring (uuid) or null
CreateSubIssueRequest
assignee_idstring (uuid) or nullassignee_idsarray of string (uuid)cycle_idstring (uuid) or nulldescriptionstring or nulldue_datestring or nulllabel_idsarray of string (uuid)priorityinteger or null; 0 to 4project_idstring (uuid) or nullstatusstring; length 0 to 100status_idstring (uuid) or nulltitlestring, required; length 1 to 500
CreateTeamRequest
acknowledge_privacy_limitationsbooleancolorstring or nulldescriptionstring or nulliconstring or nullis_privatebooleankeystring, required; length 1 to 10namestring, required; length 1 to 100
CreateTeamStatusRequest
categorystring, required; one of backlog, unstarted, started, completed, cancelledcolorstring or nullnamestring, required; length 1 to 100project_idsarray of string (uuid)
CreateViewRequest
colorstring or nulldescriptionstring or nullfiltersany JSON value, requirediconstring or nullis_sharedbooleannamestring, required; length 1 to 100
CreateWebhookRequest
eventsarray of string, required; one of issue.created, issue.updated, issue.deleted, issue.triaged, comment.created, comment.updated, comment.deleted; at least 1 itemsecretstring, required; length 8 to anyurlstring (uri), required
CreateWikiPageRequest
contentstringtitlestring
CreateWikiTreePageRequest
contentstringkindstringparent_idstring or nulltitlestring
Cycle
completed_atstring (date-time) or null, requiredcreated_atstring (date-time), requireddescriptionstring or null, requiredend_datestring (date-time) or null, requiredgoalsstring or null, requiredidstring, requirednamestring, requirednumberinteger, requiredprogressCycleProgressretrospectivestring or null, requiredstart_datestring (date-time) or null, requiredstatusstring, requiredteam_idstring, requiredupdated_atstring (date-time), required
CycleProgress
cancelledinteger, requiredcompletedinteger, requiredtotalinteger, required
DeleteComment
restorable_untilstring (date-time), requiredstatusstring, required
DeleteIssue
restorable_untilstring (date-time), requiredstatusstring, required
DeleteWikiPage
restorable_untilstring (date-time), requiredstatusstring, required
DuplicateIssueRequest
include_sub_issuesboolean
Error
errorErrorBody, required
ErrorBody
codestring, requireddetailsarray of ErrorDetailmessagestring, requiredworkspace_slugstring
ErrorDetail
fieldstringmessagestring, required
InviteMemberRequest
emailstring (email), requiredrolestring, required; one of admin, member, guest
Issue
agent_assigneesarray of IssueAgentAssigneeassigneeUserassignee_idstring or null, requiredassigneesarray of Usercreated_atstring (date-time), requiredcreatorUsercreator_idstring, requiredcycle_idstring or null, requireddescriptionstring or null, requireddue_datestring (date-time) or null, requiredidstring, requiredidentifierstring, requiredis_subscribedboolean, requiredlabelsarray of LabelparentIssueSummaryparent_idstring or null, requiredpriorityinteger, requiredproject_idstring or null, requiredrelation_countsIssueRelationCountsrelation_summaryIssueRelationSummarysort_ordernumber, requiredstatusstring, requiredstatus_idstringstatus_infoStatusInfosub_issue_countintegersub_issue_doneintegerteam_idstring, requiredtitlestring, requiredundoIssueUndoupdated_atstring (date-time), requiredversioninteger, required
IssueAgentAssignee
assigned_bystring (uuid) or null, requiredassigned_by_namestring or null, requiredavatar_colorstring, requiredcreated_atstring (date-time), requirederrorstringharnessstring, requiredidstring (uuid), requiredissue_idstring (uuid), requiredmodelstring, requirednamestring, requiredrolestring, requiredtask_idstring (uuid) or null, requiredtask_reasonstring or null, requiredtask_statestring or null, required
IssueEventDelivery
eventstring, required; one of issue.created, issue.updated, issue.deleted, issue.triagedpayloadWebhookIssuePayload, requiredtimestampstring, required
IssueHistory
agentstringagent_namestringcreated_atstring (date-time), requiredfieldstring, requiredidstring, requiredissue_idstring, requirednew_display_valuestringnew_valuestring or null, requiredold_display_valuestringold_valuestring or null, requireduser_idstring or null, required
IssueList
dataarray of Issue, requiredhas_moreboolean, requiredpageinteger, requiredper_pageinteger, requiredtotal_countinteger, required
IssueRelation
created_atstring (date-time), requiredidstring, requiredissue_idstring, requiredrelated_issueIssuerelated_issue_idstring, requiredtypestring, required
IssueRelationCounts
blocked_byinteger, requiredblockinginteger, requiredduplicateinteger, requiredrelatedinteger, required
IssueRelationSummary
blocked_byarray of IssueSummaryblockingarray of IssueSummaryduplicatearray of IssueSummaryrelatedarray of IssueSummary
IssueSummary
assigneeUserdescriptionstringidstring, requiredidentifierstring, requiredpriorityintegerstatusstringstatus_idstringstatus_infoStatusInfotitlestring, required
IssueUndo
expected_versioninteger, required; 1 to anypreviousIssueUndoPrevious, required
IssueUndoInput
expected_versioninteger; 1 to anypreviousIssueUndoPreviousInput
IssueUndoPrevious
assignee_idstring (uuid)assignee_idsarray of string (uuid)cycle_idstring (uuid)label_idsarray of string (uuid)priorityinteger; 0 to 4project_idstring (uuid)sort_ordernumberstatus_idstring (uuid)
IssueUndoPreviousInput
assignee_idstring (uuid) or nullassignee_idsarray of string (uuid) or nullcycle_idstring (uuid) or nulllabel_idsarray of string (uuid) or nullpriorityinteger or null; 0 to 4project_idstring (uuid) or nullsort_ordernumber or nullstatus_idstring (uuid) or null
Label
colorstring, requiredcreated_atstring (date-time), requireddescriptionstring or null, requiredidstring, requirednamestring, requiredparent_idstring or null, requiredproject_idstring or null, requiredupdated_atstring (date-time), required
MoveWikiPageRequest
indexintegerparent_idstring or null
Project
colorstring or null, requiredcreated_atstring (date-time), requireddescriptionstring or null, requirediconstring or null, requiredidstring, requiredlead_idstring or null, requirednamestring, requiredprogressProjectProgresssort_ordernumber, requiredstart_datestring (date-time) or null, requiredstatusstring, requiredtarget_datestring (date-time) or null, requiredteam_idstring or null, requiredupdated_atstring (date-time), required
ProjectProgress
cancelledinteger, requiredcompletedinteger, requiredtotalinteger, required
ResolveWikiReferencesRequest
idsarray of string
SetTeamVisibilityRequest
acknowledge_privacy_limitationsbooleanconfirm_publicbooleanis_privateboolean
StatusInfo
categorystring, requiredcolorstring or null, requiredidstring, requirednamestring, requiredpositioninteger, required
StatusResult
statusstring, required
Team
colorstring or null, requiredcreated_atstring (date-time), requireddescriptionstring or null, requirediconstring or null, requiredidstring, requiredis_privateboolean, requiredissue_copy_promptstring or null, requiredkeystring, requirednamestring, requiredparent_auto_close_enabledboolean, requiredsub_issue_auto_close_enabledboolean, requiredtriage_enabledboolean, requiredupdated_atstring (date-time), required
TeamMember
created_atstring (date-time), requiredteam_idstring (uuid), requireduser_idstring (uuid), required
TeamStatus
categorystring, requiredcolorstring or null, requiredcreated_atstring (date-time), requiredidstring, requiredis_defaultboolean, requirednamestring, requiredpositioninteger, requiredproject_idsarray of string, requiredslugstring, requiredteam_idstring, requiredupdated_atstring (date-time), required
UpdateCommentRequest
bodystring, required; length 1 to any
UpdateCycleRequest
descriptionstring or nullend_datestring or nullgoalsstring or nullnamestring or null; length 1 to 100retrospectivestring or nullstart_datestring or nullstatusstring or null; one of upcoming, active, completed
UpdateIssueRequest
assignee_idstring (uuid) or nullassignee_idsarray of string (uuid)cycle_idstring (uuid) or nulldescriptionstring or nulldue_datestring or nulllabel_idsarray of string (uuid)parent_idstring (uuid) or nullpriorityinteger or null; 0 to 4project_idstring (uuid) or nullsort_ordernumber or nullstatusstring or null; length 0 to 100status_idstring (uuid) or nulltitlestring or null; length 1 to 500
UpdateLabelRequest
colorstring or nulldescriptionstring or nullnamestring or null; length 1 to 50
UpdateMemberRoleRequest
rolestring, required; one of owner, admin, member, guest
UpdateProjectRequest
colorstring or null; length 0 to 7descriptionstring or nulliconstring or null; length 0 to 50lead_idstring (uuid) or nullnamestring or null; length 1 to 200sort_ordernumber or nullstart_datestring or nullstatusstring or null; one of planned, in_progress, completed, cancelledtarget_datestring or nullteam_idstring (uuid) or null
UpdateTeamRequest
colorstring or nulldescriptionstring or nulliconstring or nullissue_copy_promptstring or null; length 0 to 8000keystring or null; length 1 to 10namestring or null; length 1 to 100parent_auto_close_enabledboolean or nullsub_issue_auto_close_enabledboolean or nulltriage_enabledboolean or null
UpdateTeamStatusRequest
colorstring or nullnamestring or null; length 1 to 100positioninteger or null; 0 to anyproject_idsarray of string (uuid) or null
UpdateViewRequest
colorstring or nulldescriptionstring or nullfiltersany JSON valueiconstring or nullis_sharedboolean or nullnamestring or null; length 1 to 100
UpdateWebhookRequest
eventsarray of string; at least 1 itemis_activeboolean or nullurlstring (uri) or null
UpdateWikiPageRequest
contentstring or nulltitlestring or nullversioninteger, required; 1 to any
User
avatar_urlstring or null, requireddisplay_namestring, requiredemailstring, requiredidstring, requiredis_sysadminboolean, requirednamestring, requiredsso_workspace_slugstring, required
VelocityPoint
cancelledinteger, requiredcompletedinteger, requiredcycle_idstring, requiredcycle_namestring, requiredcycle_numberinteger, requiredend_datestring (date-time) or null, requiredscopeinteger, requiredstart_datestring (date-time) or null, required
View
created_atstring (date-time), requiredcreator_idstring, requireddescriptionstring or null, requiredfiltersany JSON value, requiredidstring, requiredis_sharedboolean, requirednamestring, requiredupdated_atstring (date-time), requiredworkspace_idstring, required
Webhook
created_atstring (date-time), requiredeventsarray of string, requiredidstring, requiredis_activeboolean, requiredupdated_atstring (date-time), requiredurlstring, required
WebhookComment
agent_task_idstring (uuid)bodystring, requiredcreated_atstring (date-time), requirededited_atstring (date-time) or null, requiredidstring (uuid), requiredissue_idstring (uuid), requiredparent_idstring (uuid) or null, requiredresolved_atstring (date-time) or null, requiredupdated_atstring (date-time), requireduser_idstring (uuid), required
WebhookCommentPayload
actor_idstring (uuid) or null, requiredcommentWebhookComment, requiredissueWebhookIssueRef, required
WebhookDelivery
attemptsinteger, requiredcompleted_atstring (date-time) or null, requiredcreated_atstring (date-time), requiredeventstring, requiredidstring, requiredlast_errorstring or null, requiredlast_status_codeinteger or null, requirednext_attempt_atstring (date-time) or null, requiredstatusstring, required; one of pending, delivered, failedupdated_atstring (date-time), required
WebhookIssue
assignee_idstring (uuid) or null, requiredcancelled_atstring (date-time) or null, requiredcompleted_atstring (date-time) or null, requiredcreated_atstring (date-time), requiredcreator_idstring (uuid), requiredcycle_idstring (uuid) or null, requireddescriptionstring or null, requireddue_datestring (date-time) or null, requiredidstring (uuid), requiredidentifierstring, requirednumberinteger, requiredparent_idstring (uuid) or null, requiredpriorityinteger, requiredproject_idstring (uuid) or null, requiredsort_ordernumber, requiredstarted_atstring (date-time) or null, requiredstatusstring, requiredstatus_idstring (uuid) or null, requiredteam_idstring (uuid), requiredtitlestring, requiredtriagedboolean, requiredtriaged_atstring (date-time) or null, requiredupdated_atstring (date-time), requiredversioninteger, requiredworkspace_idstring (uuid), required
WebhookIssuePayload
actor_idstring (uuid) or null, requiredissueWebhookIssue, required
WebhookIssueRef
idstring (uuid), requiredidentifierstring, requiredteam_idstring (uuid), required
WikiBacklinkIssue
idstring, requiredidentifierstring, requiredtitlestring, required
WikiBacklinks
issuesarray of WikiBacklinkIssue, requiredpagesarray of WikiReference, required
WikiOverview
contentstring, requiredgenerated_atstring (date-time), requiredgenerated_by_namestring or null, requiredidstring, requiredperiod_endstring, requiredperiod_startstring, requiredtriggerstring, required
WikiOverviewList
next_beforestring or null, requiredoverviewsarray of WikiOverview, required
WikiOverviewSchedule
enabledboolean, requiredfrequencystring, requiredperiod_daysinteger, requiredtimestring, requiredweekdayinteger, required
WikiOverviewScheduleInput
enabledbooleanfrequencystringperiod_daysintegertimestringweekdayinteger
WikiPage
contentstring, requiredcreated_atstring (date-time), requiredcreated_bystring or null, requiredidstring, requiredproject_idstring or null, requiredregistry_datestring or null, requiredteam_idstring or null, requiredtitlestring, requiredupdated_atstring (date-time), requiredupdated_bystring or null, requiredupdated_by_namestring or null, requiredversioninteger, required
WikiPageSummary
created_atstring (date-time), requiredidstring, requiredproject_idstring or null, requiredregistry_datestring or null, requiredteam_idstring or null, requiredtitlestring, requiredupdated_atstring (date-time), requiredupdated_bystring or null, requiredupdated_by_namestring or null, requiredversioninteger, required
WikiPublication
childrenboolean, requiredmodestring, requiredurlstring or null, required
WikiPublishRequest
childrenbooleanmodestringrotateboolean
WikiReference
accessibleboolean, requiredidstring, requiredproject_idstringscope_namestringteam_idstringtitlestring
WikiRegistryDay
contentstring, requireddatestring, requiredpage_idstring, requiredtitlestring, requiredupdated_atstring (date-time), requiredversioninteger, required
WikiRegistryFeed
daysarray of WikiRegistryDay, requirednext_beforestring or null, required
WikiRegistryRequest
textstring
WikiRevision
created_atstring (date-time), requirededited_bystring or null, requirededited_by_namestring or null, requiredidstring, requirednew_contentstring, requirednew_titlestring, requiredold_contentstring, requiredold_titlestring, requiredupdated_atstring (date-time), requiredversioninteger, required
WikiSettings
overview_last_errorstring or null, requiredoverview_last_run_atstring (date-time) or null, requiredoverview_next_run_atstring (date-time) or null, requiredoverview_scheduleWikiOverviewSchedule, requiredoverview_timezonestring, requiredregistry_enabledboolean, required
WikiSettingsRequest
overview_scheduleWikiOverviewScheduleInput or nullregistry_enabledboolean or null
WikiTreeNode
idstring, requiredkindstring, requiredparent_idstring or null, requiredpositioninteger, required
Workspace
created_atstring (date-time), requiredcurrent_user_rolestring, requiredidstring, requiredlogo_urlstring or null, requirednamestring, requiredownerWorkspaceOwnerowner_idstring, requiredprivacy_enabledboolean, requiredshare_link_min_rolestring, requiredslugstring, requiredupdated_atstring (date-time), required
WorkspaceMember
avatar_urlstring or null, requiredcreated_atstring (date-time), requiredemailstring, requirednamestring, requiredrolestring, requireduser_idstring, required
WorkspaceOwner
avatar_urlstring or null, requiredemailstring, requiredidstring, requirednamestring, required