Skip to content

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.

Download openapi.json

Your own instance serves the document for its release at /api/openapi.json.

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/workspaces

Token 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
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:read and teams: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
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
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
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 any
  • per_page (query, integer) Items per page. Defaults to 50. 1 to 100
  • status (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, project
  • sort (query, string) Sort field. Defaults to created_at. one of created_at, updated_at, priority, sort_order, status, due_date
  • order (query, string) Sort direction. one of asc, desc
  • status_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
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
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
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
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
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:read and 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.
  • 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:update and 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.
  • 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
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.

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
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.

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
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_id string (uuid), required

AttachWikiReferenceRequest

  • page_id string

BulkCreateSubIssueRequest

BulkDeleteIssue

  • deleted integer, required
  • restorable_until string (date-time), required

BulkDeleteIssueRequest

  • issue_ids array of string (uuid), required; at least 1 item

BulkIssueUndo

BulkIssueUndoInput

BulkIssueUndoItem

  • expected_version integer, required; 1 to any
  • id string (uuid), required
  • previous IssueUndoPrevious, required

BulkIssueUndoItemInput

BulkRestoreIssue

  • restored integer, required

BulkRestoreIssueRequest

  • issue_ids array of string (uuid), required; at least 1 item; at most 5000 items

BulkUndoIssue

  • updated integer, required

BulkUpdateIssue

BulkUpdateIssueRequest

  • assignee_id string (uuid) or null
  • cycle_id string or null
  • issue_ids array of string (uuid), required; at least 1 item
  • label_ids array of string (uuid)
  • parent_id string or null
  • priority integer or null; 0 to 4
  • project_id string or null
  • status string or null; one of backlog, todo, in_progress, in_review, done, cancelled
  • status_id string (uuid) or null

BurndownPoint

  • completed integer, required
  • date string, required
  • scope integer, required
  • started integer, required

Comment

  • agent_task_id string
  • body string, required
  • created_at string (date-time), required
  • edited_at string (date-time)
  • id string, required
  • issue_id string, required
  • parent_id string
  • replies array of Comment
  • resolved_at string (date-time)
  • updated_at string (date-time), required
  • user User
  • user_id string, required

CommentEventDelivery

  • event string, required; one of comment.created, comment.updated, comment.deleted
  • payload WebhookCommentPayload, required
  • timestamp string, required

CompleteCycleRequest

  • carry_over boolean
  • retrospective string or null

CompleteCycleResult

  • carried_over_count integer, required
  • cycle Cycle, required

ConvertIssueToProject

CreateCommentRequest

  • body string, required; length 1 to any
  • parent_id string (uuid) or null

CreateCycleRequest

  • description string or null
  • end_date string, required
  • goals string or null
  • name string, required; length 1 to 100
  • start_date string, required

CreateIssueRelationRequest

  • related_identifier string, required
  • type string, required; one of related, blocked_by, blocking, duplicate

CreateIssueRequest

  • assignee_id string (uuid) or null
  • assignee_ids array of string (uuid)
  • cycle_id string (uuid) or null
  • description string or null
  • due_date string or null
  • label_ids array of string (uuid)
  • parent_id string (uuid) or null
  • priority integer or null; 0 to 4
  • project_id string (uuid) or null
  • status string; length 0 to 100
  • status_id string (uuid) or null
  • team_id string (uuid), required
  • title string, required; length 1 to 500

CreateLabelRequest

  • color string, required
  • description string or null
  • name string, required; length 1 to 50
  • parent_id string (uuid) or null
  • project_id string (uuid) or null

CreateProjectRequest

  • color string or null; length 0 to 7
  • description string or null
  • icon string or null; length 0 to 50
  • lead_id string (uuid) or null
  • name string, required; length 1 to 200
  • start_date string or null
  • target_date string or null
  • team_id string (uuid) or null

CreateSubIssueRequest

  • assignee_id string (uuid) or null
  • assignee_ids array of string (uuid)
  • cycle_id string (uuid) or null
  • description string or null
  • due_date string or null
  • label_ids array of string (uuid)
  • priority integer or null; 0 to 4
  • project_id string (uuid) or null
  • status string; length 0 to 100
  • status_id string (uuid) or null
  • title string, required; length 1 to 500

CreateTeamRequest

  • acknowledge_privacy_limitations boolean
  • color string or null
  • description string or null
  • icon string or null
  • is_private boolean
  • key string, required; length 1 to 10
  • name string, required; length 1 to 100

CreateTeamStatusRequest

  • category string, required; one of backlog, unstarted, started, completed, cancelled
  • color string or null
  • name string, required; length 1 to 100
  • project_ids array of string (uuid)

CreateViewRequest

  • color string or null
  • description string or null
  • filters any JSON value, required
  • icon string or null
  • is_shared boolean
  • name string, required; length 1 to 100

CreateWebhookRequest

  • events array of string, required; one of issue.created, issue.updated, issue.deleted, issue.triaged, comment.created, comment.updated, comment.deleted; at least 1 item
  • secret string, required; length 8 to any
  • url string (uri), required

CreateWikiPageRequest

  • content string
  • title string

CreateWikiTreePageRequest

  • content string
  • kind string
  • parent_id string or null
  • title string

Cycle

  • completed_at string (date-time) or null, required
  • created_at string (date-time), required
  • description string or null, required
  • end_date string (date-time) or null, required
  • goals string or null, required
  • id string, required
  • name string, required
  • number integer, required
  • progress CycleProgress
  • retrospective string or null, required
  • start_date string (date-time) or null, required
  • status string, required
  • team_id string, required
  • updated_at string (date-time), required

CycleProgress

  • cancelled integer, required
  • completed integer, required
  • total integer, required

DeleteComment

  • restorable_until string (date-time), required
  • status string, required

DeleteIssue

  • restorable_until string (date-time), required
  • status string, required

DeleteWikiPage

  • restorable_until string (date-time), required
  • status string, required

DuplicateIssueRequest

  • include_sub_issues boolean

Error

ErrorBody

  • code string, required
  • details array of ErrorDetail
  • message string, required
  • workspace_slug string

ErrorDetail

  • field string
  • message string, required

InviteMemberRequest

  • email string (email), required
  • role string, required; one of admin, member, guest

Issue

  • agent_assignees array of IssueAgentAssignee
  • assignee User
  • assignee_id string or null, required
  • assignees array of User
  • created_at string (date-time), required
  • creator User
  • creator_id string, required
  • cycle_id string or null, required
  • description string or null, required
  • due_date string (date-time) or null, required
  • id string, required
  • identifier string, required
  • is_subscribed boolean, required
  • labels array of Label
  • parent IssueSummary
  • parent_id string or null, required
  • priority integer, required
  • project_id string or null, required
  • relation_counts IssueRelationCounts
  • relation_summary IssueRelationSummary
  • sort_order number, required
  • status string, required
  • status_id string
  • status_info StatusInfo
  • sub_issue_count integer
  • sub_issue_done integer
  • team_id string, required
  • title string, required
  • undo IssueUndo
  • updated_at string (date-time), required
  • version integer, required

IssueAgentAssignee

  • assigned_by string (uuid) or null, required
  • assigned_by_name string or null, required
  • avatar_color string, required
  • created_at string (date-time), required
  • error string
  • harness string, required
  • id string (uuid), required
  • issue_id string (uuid), required
  • model string, required
  • name string, required
  • role string, required
  • task_id string (uuid) or null, required
  • task_reason string or null, required
  • task_state string or null, required

IssueEventDelivery

  • event string, required; one of issue.created, issue.updated, issue.deleted, issue.triaged
  • payload WebhookIssuePayload, required
  • timestamp string, required

IssueHistory

  • agent string
  • agent_name string
  • created_at string (date-time), required
  • field string, required
  • id string, required
  • issue_id string, required
  • new_display_value string
  • new_value string or null, required
  • old_display_value string
  • old_value string or null, required
  • user_id string or null, required

IssueList

  • data array of Issue, required
  • has_more boolean, required
  • page integer, required
  • per_page integer, required
  • total_count integer, required

IssueRelation

  • created_at string (date-time), required
  • id string, required
  • issue_id string, required
  • related_issue Issue
  • related_issue_id string, required
  • type string, required

IssueRelationCounts

  • blocked_by integer, required
  • blocking integer, required
  • duplicate integer, required
  • related integer, required

IssueRelationSummary

IssueSummary

  • assignee User
  • description string
  • id string, required
  • identifier string, required
  • priority integer
  • status string
  • status_id string
  • status_info StatusInfo
  • title string, required

IssueUndo

IssueUndoInput

IssueUndoPrevious

  • assignee_id string (uuid)
  • assignee_ids array of string (uuid)
  • cycle_id string (uuid)
  • label_ids array of string (uuid)
  • priority integer; 0 to 4
  • project_id string (uuid)
  • sort_order number
  • status_id string (uuid)

IssueUndoPreviousInput

  • assignee_id string (uuid) or null
  • assignee_ids array of string (uuid) or null
  • cycle_id string (uuid) or null
  • label_ids array of string (uuid) or null
  • priority integer or null; 0 to 4
  • project_id string (uuid) or null
  • sort_order number or null
  • status_id string (uuid) or null

Label

  • color string, required
  • created_at string (date-time), required
  • description string or null, required
  • id string, required
  • name string, required
  • parent_id string or null, required
  • project_id string or null, required
  • updated_at string (date-time), required

MoveWikiPageRequest

  • index integer
  • parent_id string or null

Project

  • color string or null, required
  • created_at string (date-time), required
  • description string or null, required
  • icon string or null, required
  • id string, required
  • lead_id string or null, required
  • name string, required
  • progress ProjectProgress
  • sort_order number, required
  • start_date string (date-time) or null, required
  • status string, required
  • target_date string (date-time) or null, required
  • team_id string or null, required
  • updated_at string (date-time), required

ProjectProgress

  • cancelled integer, required
  • completed integer, required
  • total integer, required

ResolveWikiReferencesRequest

  • ids array of string

SetTeamVisibilityRequest

  • acknowledge_privacy_limitations boolean
  • confirm_public boolean
  • is_private boolean

StatusInfo

  • category string, required
  • color string or null, required
  • id string, required
  • name string, required
  • position integer, required

StatusResult

  • status string, required

Team

  • color string or null, required
  • created_at string (date-time), required
  • description string or null, required
  • icon string or null, required
  • id string, required
  • is_private boolean, required
  • issue_copy_prompt string or null, required
  • key string, required
  • name string, required
  • parent_auto_close_enabled boolean, required
  • sub_issue_auto_close_enabled boolean, required
  • triage_enabled boolean, required
  • updated_at string (date-time), required

TeamMember

  • created_at string (date-time), required
  • team_id string (uuid), required
  • user_id string (uuid), required

TeamStatus

  • category string, required
  • color string or null, required
  • created_at string (date-time), required
  • id string, required
  • is_default boolean, required
  • name string, required
  • position integer, required
  • project_ids array of string, required
  • slug string, required
  • team_id string, required
  • updated_at string (date-time), required

UpdateCommentRequest

  • body string, required; length 1 to any

UpdateCycleRequest

  • description string or null
  • end_date string or null
  • goals string or null
  • name string or null; length 1 to 100
  • retrospective string or null
  • start_date string or null
  • status string or null; one of upcoming, active, completed

UpdateIssueRequest

  • assignee_id string (uuid) or null
  • assignee_ids array of string (uuid)
  • cycle_id string (uuid) or null
  • description string or null
  • due_date string or null
  • label_ids array of string (uuid)
  • parent_id string (uuid) or null
  • priority integer or null; 0 to 4
  • project_id string (uuid) or null
  • sort_order number or null
  • status string or null; length 0 to 100
  • status_id string (uuid) or null
  • title string or null; length 1 to 500

UpdateLabelRequest

  • color string or null
  • description string or null
  • name string or null; length 1 to 50

UpdateMemberRoleRequest

  • role string, required; one of owner, admin, member, guest

UpdateProjectRequest

  • color string or null; length 0 to 7
  • description string or null
  • icon string or null; length 0 to 50
  • lead_id string (uuid) or null
  • name string or null; length 1 to 200
  • sort_order number or null
  • start_date string or null
  • status string or null; one of planned, in_progress, completed, cancelled
  • target_date string or null
  • team_id string (uuid) or null

UpdateTeamRequest

  • color string or null
  • description string or null
  • icon string or null
  • issue_copy_prompt string or null; length 0 to 8000
  • key string or null; length 1 to 10
  • name string or null; length 1 to 100
  • parent_auto_close_enabled boolean or null
  • sub_issue_auto_close_enabled boolean or null
  • triage_enabled boolean or null

UpdateTeamStatusRequest

  • color string or null
  • name string or null; length 1 to 100
  • position integer or null; 0 to any
  • project_ids array of string (uuid) or null

UpdateViewRequest

  • color string or null
  • description string or null
  • filters any JSON value
  • icon string or null
  • is_shared boolean or null
  • name string or null; length 1 to 100

UpdateWebhookRequest

  • events array of string; at least 1 item
  • is_active boolean or null
  • url string (uri) or null

UpdateWikiPageRequest

  • content string or null
  • title string or null
  • version integer, required; 1 to any

User

  • avatar_url string or null, required
  • display_name string, required
  • email string, required
  • id string, required
  • is_sysadmin boolean, required
  • name string, required
  • sso_workspace_slug string, required

VelocityPoint

  • cancelled integer, required
  • completed integer, required
  • cycle_id string, required
  • cycle_name string, required
  • cycle_number integer, required
  • end_date string (date-time) or null, required
  • scope integer, required
  • start_date string (date-time) or null, required

View

  • created_at string (date-time), required
  • creator_id string, required
  • description string or null, required
  • filters any JSON value, required
  • id string, required
  • is_shared boolean, required
  • name string, required
  • updated_at string (date-time), required
  • workspace_id string, required

Webhook

  • created_at string (date-time), required
  • events array of string, required
  • id string, required
  • is_active boolean, required
  • updated_at string (date-time), required
  • url string, required

WebhookComment

  • agent_task_id string (uuid)
  • body string, required
  • created_at string (date-time), required
  • edited_at string (date-time) or null, required
  • id string (uuid), required
  • issue_id string (uuid), required
  • parent_id string (uuid) or null, required
  • resolved_at string (date-time) or null, required
  • updated_at string (date-time), required
  • user_id string (uuid), required

WebhookCommentPayload

WebhookDelivery

  • attempts integer, required
  • completed_at string (date-time) or null, required
  • created_at string (date-time), required
  • event string, required
  • id string, required
  • last_error string or null, required
  • last_status_code integer or null, required
  • next_attempt_at string (date-time) or null, required
  • status string, required; one of pending, delivered, failed
  • updated_at string (date-time), required

WebhookIssue

  • assignee_id string (uuid) or null, required
  • cancelled_at string (date-time) or null, required
  • completed_at string (date-time) or null, required
  • created_at string (date-time), required
  • creator_id string (uuid), required
  • cycle_id string (uuid) or null, required
  • description string or null, required
  • due_date string (date-time) or null, required
  • id string (uuid), required
  • identifier string, required
  • number integer, required
  • parent_id string (uuid) or null, required
  • priority integer, required
  • project_id string (uuid) or null, required
  • sort_order number, required
  • started_at string (date-time) or null, required
  • status string, required
  • status_id string (uuid) or null, required
  • team_id string (uuid), required
  • title string, required
  • triaged boolean, required
  • triaged_at string (date-time) or null, required
  • updated_at string (date-time), required
  • version integer, required
  • workspace_id string (uuid), required

WebhookIssuePayload

  • actor_id string (uuid) or null, required
  • issue WebhookIssue, required

WebhookIssueRef

  • id string (uuid), required
  • identifier string, required
  • team_id string (uuid), required

WikiBacklinkIssue

  • id string, required
  • identifier string, required
  • title string, required

WikiOverview

  • content string, required
  • generated_at string (date-time), required
  • generated_by_name string or null, required
  • id string, required
  • period_end string, required
  • period_start string, required
  • trigger string, required

WikiOverviewList

  • next_before string or null, required
  • overviews array of WikiOverview, required

WikiOverviewSchedule

  • enabled boolean, required
  • frequency string, required
  • period_days integer, required
  • time string, required
  • weekday integer, required

WikiOverviewScheduleInput

  • enabled boolean
  • frequency string
  • period_days integer
  • time string
  • weekday integer

WikiPage

  • content string, required
  • created_at string (date-time), required
  • created_by string or null, required
  • id string, required
  • project_id string or null, required
  • registry_date string or null, required
  • team_id string or null, required
  • title string, required
  • updated_at string (date-time), required
  • updated_by string or null, required
  • updated_by_name string or null, required
  • version integer, required

WikiPageSummary

  • created_at string (date-time), required
  • id string, required
  • project_id string or null, required
  • registry_date string or null, required
  • team_id string or null, required
  • title string, required
  • updated_at string (date-time), required
  • updated_by string or null, required
  • updated_by_name string or null, required
  • version integer, required

WikiPublication

  • children boolean, required
  • mode string, required
  • url string or null, required

WikiPublishRequest

  • children boolean
  • mode string
  • rotate boolean

WikiReference

  • accessible boolean, required
  • id string, required
  • project_id string
  • scope_name string
  • team_id string
  • title string

WikiRegistryDay

  • content string, required
  • date string, required
  • page_id string, required
  • title string, required
  • updated_at string (date-time), required
  • version integer, required

WikiRegistryFeed

  • days array of WikiRegistryDay, required
  • next_before string or null, required

WikiRegistryRequest

  • text string

WikiRevision

  • created_at string (date-time), required
  • edited_by string or null, required
  • edited_by_name string or null, required
  • id string, required
  • new_content string, required
  • new_title string, required
  • old_content string, required
  • old_title string, required
  • updated_at string (date-time), required
  • version integer, required

WikiSettings

  • overview_last_error string or null, required
  • overview_last_run_at string (date-time) or null, required
  • overview_next_run_at string (date-time) or null, required
  • overview_schedule WikiOverviewSchedule, required
  • overview_timezone string, required
  • registry_enabled boolean, required

WikiSettingsRequest

WikiTreeNode

  • id string, required
  • kind string, required
  • parent_id string or null, required
  • position integer, required

Workspace

  • created_at string (date-time), required
  • current_user_role string, required
  • id string, required
  • logo_url string or null, required
  • name string, required
  • owner WorkspaceOwner
  • owner_id string, required
  • privacy_enabled boolean, required
  • share_link_min_role string, required
  • slug string, required
  • updated_at string (date-time), required

WorkspaceMember

  • avatar_url string or null, required
  • created_at string (date-time), required
  • email string, required
  • name string, required
  • role string, required
  • user_id string, required

WorkspaceOwner

  • avatar_url string or null, required
  • email string, required
  • id string, required
  • name string, required

Run the API on your own server

Deploy Kuayle with Docker Compose, create a personal access token and point your client at your instance.