Generated referenceREST API · Preview
The v1 contract. From the server’s schema.
This reference is generated from the public API’s Rust types. Self-hosted installations can run a different version: use Personal settings → API for the reference and base URL of your running instance.
Public operations
Relative paths below follow the instance’s /api/rest/v1 base URL. Authentication, scopes, and resource access checks apply to every protected operation.
API version v1 · OpenAPI 3.1.0 · 52 operations
get / Identity and instance version
Preview. Required scope: any. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
patch /comments/{id} Edit your own comment
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- bodystring · required
- content_formatstring,null
Responses
200 Success
application/json
- bodystring,null · required
- created_atstring,null · required
- idinteger · required
- objectstring · required
- ticket_idinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
delete /comments/{id} Delete a resource (comments and worklogs: own only)
Preview. Required scope: planner:delete. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
204 Deleted
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /health Unauthenticated instance information
Preview. Required scope: none. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /openapi.json Unauthenticated instance information
Preview. Required scope: none. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects List projects
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- colorstring,null · required
- created_atstring,null · required
- idinteger · required
- keystring · required
- namestring,null · required
- objectstring · required
- timezonestring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- colorstring,null · required
- created_atstring,null · required
- idinteger · required
- keystring · required
- namestring,null · required
- objectstring · required
- timezonestring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects/{id}/members Project configuration
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of object
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects/{id}/statuses Project configuration
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of object
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects/{id}/tags Project configuration
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of object
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /projects/{id}/ticket-types Project configuration
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of object
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /sprints List sprints
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
Responses
200 Success
application/json
- dataarray · required
- Array of
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /sprints Create a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- end_datestring,null
- goalstring,null
- namestring · required
- project_idinteger · required
- regression_tag_modestring,null
- require_regressionboolean
- start_datestring,null
Responses
201 Success
application/json
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /sprints/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
patch /sprints/{id} Partially update a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- end_datestring,null
- goalstring,null
- namestring,null
- regression_tag_modestring,null
- require_regressionboolean,null
- start_datestring,null
Responses
200 Success
application/json
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /sprints/{id}/complete Lifecycle action
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
objectResponses
200 Success
application/json
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /sprints/{id}/start Lifecycle action
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
objectResponses
200 Success
application/json
- created_atstring,null · required
- end_datestring,null · required
- goalstring,null · required
- idinteger · required
- is_finishedboolean,null · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- regression_tag_modestring,null · required
- require_regressionboolean,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-cases List test-cases
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
- module_id query
- integer
- q query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- created_atstring,null · required
- created_by_idinteger,null · required
- description_json · required
- expected_resultstring,null · required
- idinteger · required
- keystring · required
- module_idinteger,null · required
- objectstring · required
- preconditionsstring,null · required
- prioritystring,null · required
- project_idinteger,null · required
- statusstring,null · required
- steps · required
- titlestring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-cases/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- created_atstring,null · required
- created_by_idinteger,null · required
- description_json · required
- expected_resultstring,null · required
- idinteger · required
- keystring · required
- module_idinteger,null · required
- objectstring · required
- preconditionsstring,null · required
- prioritystring,null · required
- project_idinteger,null · required
- statusstring,null · required
- steps · required
- titlestring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-reports List test-reports
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
Responses
200 Success
application/json
- dataarray · required
- Array of
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- idinteger · required
- issued_atstring,null · required
- kindstring,null · required
- numberinteger,null · required
- objectstring · required
- project_idinteger,null · required
- statusstring,null · required
- test_run_idinteger,null · required
- titlestring,null · required
- updated_atstring,null · required
- verdictstring,null · required
- versioninteger,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-reports/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- idinteger · required
- issued_atstring,null · required
- kindstring,null · required
- numberinteger,null · required
- objectstring · required
- project_idinteger,null · required
- statusstring,null · required
- test_run_idinteger,null · required
- titlestring,null · required
- updated_atstring,null · required
- verdictstring,null · required
- versioninteger,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-runs List test-runs
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
- sprint_id query
- integer
- status query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- assignee_idinteger,null · required
- completed_atstring,null · required
- completed_by_idinteger,null · required
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- goalstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- platformstring,null · required
- project_idinteger,null · required
- run_typestring,null · required
- sprint_idinteger,null · required
- started_atstring,null · required
- statusstring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /test-runs Create a resource
Preview. Required scope: qa:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- assignee_idinteger,null
- environment_idinteger,null
- goalstring,null
- namestring,null
- platformstring,null
- project_idinteger · required
- run_typestring,null
- sprint_idinteger,null
- tag_idsarray
- Array of integer (int32)
- test_case_idsarray
- Array of integer (int32)
- test_plan_idinteger,null
- ticket_idsarray
- Array of integer (int32)
Responses
201 Success
application/json
- assignee_idinteger,null · required
- completed_atstring,null · required
- completed_by_idinteger,null · required
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- goalstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- platformstring,null · required
- project_idinteger,null · required
- run_typestring,null · required
- sprint_idinteger,null · required
- started_atstring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-runs/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- assignee_idinteger,null · required
- completed_atstring,null · required
- completed_by_idinteger,null · required
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- goalstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- platformstring,null · required
- project_idinteger,null · required
- run_typestring,null · required
- sprint_idinteger,null · required
- started_atstring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /test-runs/{id}/complete Lifecycle action
Preview. Required scope: qa:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- notesstring,null
- skip_pendingboolean
Responses
200 Success
application/json
- assignee_idinteger,null · required
- completed_atstring,null · required
- completed_by_idinteger,null · required
- created_atstring,null · required
- created_by_idinteger,null · required
- created_viastring,null · required
- goalstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- platformstring,null · required
- project_idinteger,null · required
- run_typestring,null · required
- sprint_idinteger,null · required
- started_atstring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /test-runs/{id}/items List snapshotted run items (secret data omitted)
Preview. Required scope: qa:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of
- case_key_snapshotstring,null · required
- created_atstring,null · required
- elapsed_secsinteger,null · required
- executed_atstring,null · required
- executed_by_idinteger,null · required
- idinteger · required
- notesstring,null · required
- objectstring · required
- resultstring,null · required
- test_case_idinteger,null · required
- test_run_idinteger,null · required
- title_snapshotstring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /test-runs/{id}/results Lifecycle action
Preview. Required scope: qa:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- resultsarray · required
- Array of
- change_reasonstring,null
- elapsed_secsinteger,null
- notesstring,null
- resultstring · required
- test_case_idinteger,null
- test_case_keystring,null
Responses
200 Success
application/json
- dataarray · required
- Array of
- case_key_snapshotstring,null · required
- created_atstring,null · required
- elapsed_secsinteger,null · required
- executed_atstring,null · required
- executed_by_idinteger,null · required
- idinteger · required
- notesstring,null · required
- objectstring · required
- resultstring,null · required
- test_case_idinteger,null · required
- test_run_idinteger,null · required
- title_snapshotstring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /tickets List tickets
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
- status_id query
- integer
- status query
- string
- assignee_id query
- integer
- sprint_id query
- integer
- type_id query
- integer
- tag query
- string
- q query
- string
- updated_since query
- string
- created_since query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- actual_timeinteger,null
- assignee_idinteger,null
- created_atstring · required
- created_by_idinteger,null
- descriptionstring,null
- end_datestring,null
- estimated_timeinteger,null
- idinteger · required
- keystring · required
- namestring · required
- objectstring · required
- parent_idinteger,null
- positionstring,null
- prioritystring,null
- project_idinteger · required
- sourcestring · required
- sprint_idinteger,null
- start_datestring,null
- statusstring,null
- story_pointsnumber,null
- tag_idsarray · required
- Array of integer (int32)
- type_idinteger,null
- updated_atstring · required
- version_idinteger,null
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /tickets Create a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- assignee_idinteger,null
- content_formatstring,null
- descriptionstring,null
- namestring · required
- parent_idinteger,null
- prioritystring,null
- project_idinteger · required
- sprint_idinteger,null
- story_pointsnumber,null
- tag_idsarray
- Array of integer (int32)
- type_idinteger · required
- version_idinteger,null
Responses
201 Success
application/json
- actual_timeinteger,null
- assignee_idinteger,null
- created_atstring · required
- created_by_idinteger,null
- descriptionstring,null
- end_datestring,null
- estimated_timeinteger,null
- idinteger · required
- keystring · required
- namestring · required
- objectstring · required
- parent_idinteger,null
- positionstring,null
- prioritystring,null
- project_idinteger · required
- sourcestring · required
- sprint_idinteger,null
- start_datestring,null
- statusstring,null
- story_pointsnumber,null
- tag_idsarray · required
- Array of integer (int32)
- type_idinteger,null
- updated_atstring · required
- version_idinteger,null
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /tickets/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- actual_timeinteger,null
- assignee_idinteger,null
- created_atstring · required
- created_by_idinteger,null
- descriptionstring,null
- end_datestring,null
- estimated_timeinteger,null
- idinteger · required
- keystring · required
- namestring · required
- objectstring · required
- parent_idinteger,null
- positionstring,null
- prioritystring,null
- project_idinteger · required
- sourcestring · required
- sprint_idinteger,null
- start_datestring,null
- statusstring,null
- story_pointsnumber,null
- tag_idsarray · required
- Array of integer (int32)
- type_idinteger,null
- updated_atstring · required
- version_idinteger,null
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
patch /tickets/{id} Partially update a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- assignee_idinteger,null
- content_formatstring,null
- descriptionstring,null
- end_datestring,null
- namestring,null
- parent_idinteger,null
- prioritystring,null
- sprint_idinteger,null
- start_datestring,null
- statusstring,null
- status_idinteger,null
- story_pointsnumber,null
- tag_idsarray,null
- array,null
- type_idinteger,null
- version_idinteger,null
Responses
200 Success
application/json
- actual_timeinteger,null
- assignee_idinteger,null
- created_atstring · required
- created_by_idinteger,null
- descriptionstring,null
- end_datestring,null
- estimated_timeinteger,null
- idinteger · required
- keystring · required
- namestring · required
- objectstring · required
- parent_idinteger,null
- positionstring,null
- prioritystring,null
- project_idinteger · required
- sourcestring · required
- sprint_idinteger,null
- start_datestring,null
- statusstring,null
- story_pointsnumber,null
- tag_idsarray · required
- Array of integer (int32)
- type_idinteger,null
- updated_atstring · required
- version_idinteger,null
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
delete /tickets/{id} Delete a resource (comments and worklogs: own only)
Preview. Required scope: planner:delete. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
204 Deleted
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /tickets/{id}/comments List ticket comments
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- cursor query
- string
- order query
- Resource lists order by timestamp and ID. Project metadata orders by stable configuration ID in the requested direction. string
Responses
200 Success
application/json
- dataarray · required
- Array of
- bodystring,null · required
- created_atstring,null · required
- idinteger · required
- objectstring · required
- ticket_idinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /tickets/{id}/comments Create a comment as the token owner
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- bodystring · required
- content_formatstring,null
Responses
201 Success
application/json
- bodystring,null · required
- created_atstring,null · required
- idinteger · required
- objectstring · required
- ticket_idinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /users List users
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- emailstring,null · required
- first_namestring,null · required
- idinteger · required
- imagestring,null · required
- is_activeboolean,null · required
- last_namestring,null · required
- objectstring · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /versions List versions
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- project_id query
- integer
Responses
200 Success
application/json
- dataarray · required
- Array of
- created_atstring,null · required
- descriptionstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- release_datestring,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /versions/{id} Get a resource (ticket and test-case IDs or keys)
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- created_atstring,null · required
- descriptionstring,null · required
- idinteger · required
- namestring,null · required
- objectstring · required
- project_idinteger,null · required
- release_datestring,null · required
- start_datestring,null · required
- statusstring,null · required
- updated_atstring,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /webhook-deliveries/{id} Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /webhook-deliveries/{id}/redeliver Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /webhook-endpoints Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Responses
200 Success
application/json
Array of
- api_versionstring · required
- descriptionstring
- enabledboolean · required
- event_typesarray · required
- Array of string
- idstring · required
- namestring · required
- project_idsarray,null · required
- array,null
- urlstring · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /webhook-endpoints Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- descriptionstring
- enabledboolean
- event_typesarray · required
- Array of string
- namestring · required
- project_idsarray,null
- array,null
- urlstring · required
Responses
201 Success
application/json
- api_versionstring · required
- descriptionstring
- enabledboolean · required
- event_typesarray · required
- Array of string
- idstring · required
- namestring · required
- project_idsarray,null · required
- array,null
- urlstring · required
- secretstring · required
- One-time whsec_ signing secret. Stored encrypted; repeated only on a matching idempotency replay.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /webhook-endpoints/{id} Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
- api_versionstring · required
- descriptionstring
- enabledboolean · required
- event_typesarray · required
- Array of string
- idstring · required
- namestring · required
- project_idsarray,null · required
- array,null
- urlstring · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
patch /webhook-endpoints/{id} Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- descriptionstring,null
- enabledboolean,null
- event_typesarray,null
- array,null
- namestring,null
- project_idsarray,null
- Omitted preserves the filter; null means all projects.
- array,null
- urlstring,null
Responses
200 Success
application/json
- api_versionstring · required
- descriptionstring
- enabledboolean · required
- event_typesarray · required
- Array of string
- idstring · required
- namestring · required
- project_idsarray,null · required
- array,null
- urlstring · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
delete /webhook-endpoints/{id} Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /webhook-endpoints/{id}/deliveries Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- limit query
- integer
- before query
- integer
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /webhook-endpoints/{id}/redeliver Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- sincestring · required
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /webhook-endpoints/{id}/rotate-secret Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /webhook-endpoints/{id}/test Manage workspace webhooks (workspace admin required)
Preview. Required scope: webhooks:admin. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Responses
200 Success
application/json
object401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
get /worklogs List worklogs
Preview. Required scope: planner:read. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- limit query
- integer
- cursor query
- string
- order query
- string
- ticket_id query
- integer
- user_id query
- integer
- from query
- string
- to query
- string
Responses
200 Success
application/json
- dataarray · required
- Array of
- created_atstring,null · required
- descriptionstring,null · required
- end_datestring,null · required
- idinteger · required
- objectstring · required
- start_datestring,null · required
- ticket_idinteger,null · required
- time_spentinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
- has_moreboolean · required
- next_cursorstring,null · required
- objectstring · required
- sync_untilstring,null
- Server high-water mark, unchanged across resource pages. After all pages, use this as the next updated_since checkpoint with an overlap for long-running transactions. Rows updated during paging are deferred to the next sync.
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
post /worklogs Create a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- Idempotency-Key header
- Optional on creates and webhook POST actions. Same key and canonical request replays the original status and body for 24 hours. Different request: 409. In flight: 409, Retry-After: 1. string
Request body application/json
- descriptionstring,null
- end_datestring,null
- start_datestring,null
- ticket_idinteger · required
- time_spentinteger · required
Responses
201 Success
application/json
- created_atstring,null · required
- descriptionstring,null · required
- end_datestring,null · required
- idinteger · required
- objectstring · required
- start_datestring,null · required
- ticket_idinteger,null · required
- time_spentinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
patch /worklogs/{id} Partially update a resource
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Request body application/json
- descriptionstring,null
- end_datestring,null
- start_datestring,null
- time_spentinteger,null
Responses
200 Success
application/json
- created_atstring,null · required
- descriptionstring,null · required
- end_datestring,null · required
- idinteger · required
- objectstring · required
- start_datestring,null · required
- ticket_idinteger,null · required
- time_spentinteger,null · required
- updated_atstring,null · required
- user_idinteger,null · required
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
delete /worklogs/{id} Delete a resource (comments and worklogs: own only)
Preview. Required scope: planner:write. Token scopes, current member modules, project membership, project allow-list and tenant isolation all apply. Out-of-reach objects return 404.
Requires Authorization: Bearer <personal access key> and the operation’s scope.
Parameters
- id path · required
- string
Responses
204 Deleted
401 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
403 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
404 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
409 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
413 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
422 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
429 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required
500 Problem details (stable machine-readable code)
application/problem+json
- codestring · required
- invalid_token | insufficient_scope | not_found | validation_failed | idempotency_conflict | conflict | rate_limited | limit_reached | payload_too_large | internal
- detailstring · required
- request_idstring · required
- statusinteger · required
- titlestring · required
- typestring · required