​

issues

orc issues creates Issues in a Workspace and updates their state, assignee, priority, and Project or Initiative associations. Inspect comments, activity, reactions, and related Issues, and manage personal display preferences and saved views. Deletion is a soft delete with a restore operation.

Authentication and a selected Workspace are required. Updates must include version from the current Issue. The project_id used for associations is a UUID, not a Project lookup key.

List Issues in the Workspace.

Filters by state, priority, classification, Project, milestone, Initiative, assignee, label, or search query. Omitted filters leave that dimension unrestricted. You can also control ordering and completed or child Issue handling.

Filter by exact workflow state. Omit to include all states.

Type: string. Optional.

Filter by exact priority. Omit to include all priorities and unprioritized issues.

Type: string. Optional.

Filter by work classification. Omit to include all classifications.

Type: string. Optional.

Filter by project UUID. Omit to include issues with or without a project.; max 500 chars

Type: string. Optional.

Filter by membership in this milestone. Omit to leave milestone membership unrestricted.; max 500 chars

Type: string. Optional.

Filter by initiative id. Omit to leave initiative assignment unrestricted.; max 500 chars

Type: string. Optional.

Filter by assigned member id. Omit to include assigned and unassigned issues.; max 500 chars

Type: string. Optional.

Require this exact label in the issue label list. Omit to leave labels unrestricted.; max 100 chars

Type: string. Optional.

Case-insensitive search across internal id, title, description and rationale. SQL LIKE wildcards % and _ are supported. Omit to disable text filtering.; max 500 chars

Type: string. Optional.

Sort field. Defaults to created. Reuse the same ordering and filters with next_cursor.

Type: string. Optional.

Override sort direction and the id tie-breaker. Defaults to descending for created/updated and ascending for the other sort fields.; enum: asc|desc

Type: string. Optional.

When true, place done, closed and duplicate issues after unfinished work, ordered by newest state transition first. Defaults to false.; enum: true|false

Type: string. Optional.

Filter terminal issues by their latest state transition: day=24 hours, week=7 days, month=one calendar month. none excludes terminal issues; all or omission imposes no time window. Unfinished issues are unaffected.; enum: all|day|week|month|none

Type: string. Optional.

Set false to exclude children of non-deleted parent issues. Omitted or true includes them.; enum: true|false

Type: string. Optional.

Creates an Issue with title and classification. Titles are trimmed before storage and limited to 500 characters. You can also supply a description, state, priority, and associations within the same Workspace.

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

Type: string. Optional.

Active workspace member to assign. Omitted on create means unassigned; null clears the assignment on update.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Active canonical issue in the same workspace. Required for state duplicate; must not reference this issue. Null clears the reference only when the resulting state permits it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

(required) Body field: classification

Type: string. Optional.

Issue details. Omit on create for null; on update omit to retain the value or send null to clear.; max 10000 chars

Type: string. Optional.

Calendar due date in YYYY-MM-DD form. Omit on create for no due date; send null on update to clear it.; (use "null" or "reset" to clear)

Type: string. Optional.

Initiative id in the same workspace. Omit on create for no initiative; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Unique labels after trimming. Defaults to [] on create. On update replaces all labels; [] clears them.; csv

Type: string. Optional.

Body field: observation_ref

Type: string. Optional.

Priority, or null for no priority. Omitted on create means null; omitted on update leaves it unchanged.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)

Type: string. Optional.

Project UUID in the same workspace. Omit on create for no project; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Reason for this issue. Defaults to the trimmed title on create; omit on update to retain it.; max 10000 chars

Type: string. Optional.

Body field: state

Type: string. Optional.

Body field: target_entity_ref

Type: string. Optional.

(required) Short issue title, trimmed before storage.; max 500 chars

Type: string. Optional.

Retrieves current information by Issue ID. Read the version for an update from this response.

Updates an Issue using its ID and current version. A stale version returns 409 version_conflict. Omitted descriptions and associations are preserved; fields that support clearing can be cleared with null.

Active workspace member to assign. Omitted on create means unassigned; null clears the assignment on update.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Active canonical issue in the same workspace. Required for state duplicate; must not reference this issue. Null clears the reference only when the resulting state permits it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Body field: classification

Type: string. Optional.

Issue details. Omit on create for null; on update omit to retain the value or send null to clear.; (use "null" or "reset" to clear); max 10000 chars

Type: string. Optional.

Calendar due date in YYYY-MM-DD form. Omit on create for no due date; send null on update to clear it.; (use "null" or "reset" to clear)

Type: string. Optional.

Initiative id in the same workspace. Omit on create for no initiative; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Unique labels after trimming. Defaults to [] on create. On update replaces all labels; [] clears them.; csv

Type: string. Optional.

Body field: observation_ref

Type: string. Optional.

Priority, or null for no priority. Omitted on create means null; omitted on update leaves it unchanged.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)

Type: string. Optional.

Project UUID in the same workspace. Omit on create for no project; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Non-negative decimal string for the workspace-shared manual order. Omit to retain the current rank.; max 100 chars

Type: string. Optional.

Reason for this issue. Defaults to the trimmed title on create; omit on update to retain it.; max 10000 chars

Type: string. Optional.

Body field: state

Type: string. Optional.

Body field: target_entity_ref

Type: string. Optional.

Short issue title, trimmed before storage.; max 500 chars

Type: string. Optional.

(required) Version read from the current Issue. A stale version returns 409 version_conflict.

Type: number. Optional.

Soft-deletes an Issue by ID. Use restore to restore it.

Lists Issue activity. Paginate with --limit and --cursor.

Lists Issue comments. Paginate with --limit and --cursor.

Posts a comment using an Issue ID and body. Specify parent_id for a reply.

(required) Comment text, trimmed before storage.; max 10000 chars

Type: string. Optional.

Top-level comment id on this issue to reply to. Omit or null for a new top-level comment. Replies to replies are rejected with 422.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

Adds the specified Issue to favorites.

Removes the specified Issue from favorites.

Lists reactions on an Issue.

Adds a reaction using an Issue ID and emoji. Specify comment_id for a reaction to a comment.

Comment on the same issue to react to. Omit or null to react to the issue itself.; (use "null" or "reset" to clear); max 500 chars

Type: string. Optional.

(required) Reaction text, trimmed before storage.; max 64 chars

Type: string. Optional.

Removes a reaction using an Issue ID and emoji. Also specify --comment-id when the target is a comment.

Comment id on this issue. Omit to remove the reaction on the issue body.; (use "null" or "reset" to clear)

Type: string. Optional.

Restores a soft-deleted Issue by ID.

Subscribes to the specified Issue.

Unsubscribes from the specified Issue.

Retrieves your personal Issue display preferences, separate from Issue data and shared views.

Saves personal settings such as filters, grouping, layout, and ordering. Send a complete settings resource with --stdin.

(required) Whether completed issues follow unfinished issues in newest-transition order.

Type: string. Optional.

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

Type: string. Optional.

(required) Ordered list of issue properties to display. Values must be unique. An empty array saves no optional display properties.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

Type: string. Optional.

(required) Body field: filter

Type: string. Optional.

(required) Body field: grouping

Type: string. Optional.

Optional saved group ordering direction.; enum: asc|desc

Type: string. Optional.

(required) Body field: layout

Type: string. Optional.

(required) Body field: ordering

Type: string. Optional.

Optional saved issue sort direction.; enum: asc|desc

Type: string. Optional.

(required) Whether the view displays completed issues.

Type: string. Optional.

(required) Whether the view displays empty groups or board columns.

Type: string. Optional.

Saved option controlling whether child issues are shown.

Type: string. Optional.

Lists IssueViews visible to the current authenticated principal.

Creates an IssueView with a name, visibility, filter, grouping, layout, and ordering. This is separate from saved-views, which stores query filters only.

(required) Whether completed issues follow unfinished issues in newest-transition order.

Type: string. Optional.

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

Type: string. Optional.

(required) Ordered list of issue properties to display. Values must be unique. An empty array saves no optional display properties.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

Type: string. Optional.

(required) Body field: filter

Type: string. Optional.

(required) Body field: grouping

Type: string. Optional.

Optional saved group ordering direction.; enum: asc|desc

Type: string. Optional.

(required) Body field: layout

Type: string. Optional.

(required) Display name for the saved view.; max 200 chars

Type: string. Optional.

(required) Body field: ordering

Type: string. Optional.

Optional saved issue sort direction.; enum: asc|desc

Type: string. Optional.

(required) Whether the view displays completed issues.

Type: string. Optional.

(required) Whether the view displays empty groups or board columns.

Type: string. Optional.

Saved option controlling whether child issues are shown.

Type: string. Optional.

(required) Body field: visibility

Type: string. Optional.

Retrieves an IssueView by view ID.

Updates the name, filter, layout, and other settings of a view ID. An omitted filter is preserved; null clears it.

Replacement completion ordering option. Omit to retain it.

Type: string. Optional.

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

Type: string. Optional.

Replacement ordered display-property list. Values must be unique. Omit to retain the current list; send an empty array to clear it.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

Type: string. Optional.

Replacement filter conjunction. Null clears the filter; omission retains it.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)

Type: string. Optional.

Body field: grouping

Type: string. Optional.

Optional saved group ordering direction.; enum: asc|desc

Type: string. Optional.

Body field: layout

Type: string. Optional.

Replacement display name. Omit to retain it.; max 200 chars

Type: string. Optional.

Body field: ordering

Type: string. Optional.

Optional saved issue sort direction.; enum: asc|desc

Type: string. Optional.

Replacement completed-issue visibility. Omit to retain it.

Type: string. Optional.

Replacement empty-column visibility. Omit to retain it.

Type: string. Optional.

Saved option controlling whether child issues are shown.

Type: string. Optional.

Deletes an IssueView by view ID.

Sets the default view using a view ID and scope. personal applies only to you; workspace changes the shared default and requires Workspace owner permission.

(required) personal changes only your default view. workspace changes the shared default and requires workspace owner permission.; enum: personal|workspace

Type: string. Optional.

Clears the default view using a view ID and scope. personal and workspace have the same permission boundaries as setting a default.

(required) personal changes only your default view. workspace changes the shared default and requires workspace owner permission.; enum: personal|workspace

Type: string. Optional.

Lists relations for the specified Issue.

Creates a relation using type and another active Issue in the same Workspace in related_issue_id. An Issue cannot relate to itself.

(required) Other active issue in the same workspace. Must not be the source issue.; max 500 chars

Type: string. Optional.

(required) Body field: type

Type: string. Optional.

Removes a relation using an Issue ID and relation ID.

Executes multiple actions supplied in JSON items. Items are processed independently in input order; result indices refer to the input array. Individual failures do not roll back successful actions.

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

Type: string. Optional.

(required) Actions processed independently in input order. Each result index refers to this array. A malformed request is rejected before processing; reported item failures do not roll back successful items.; JSON array of objects (use --stdin for large resources)

Type: string. Optional.

Filter Issues by a Project UUID.

Include the retrieved version and fields to change in the update file.

Read the current Issue and submit an update file.

Post a comment on an Issue.

Set your personal default view.

If an update returns 409 version_conflict, read the current content and version with get, review the intended changes, and resubmit. Do not retry with the stale version.

Malformed batch requests are rejected before processing, but individual errors after processing begins can result in partial success. Check each result index and outcome to avoid repeating successful items.

The following global options can be used with orc issues:

For details and examples, see global options.