Skip to main content
Quire logo
  • Category: project management
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 102
  • Triggers: 0
  • Slug: QUIRE
  • Version: 20261101_00

Tools

Slug: QUIRE_ADD_INSIGHT_FIELDAdd a formula or lookup custom field to an insight by OID or by owner ID plus insight ID. The tool declares the Admin app permission as a requirement.

Input Parameters

object
required
Complete field definition to add.
string
Owner ID required with owner_type and insight_id for the ID route.
string
Insight ID required with owner_type and owner_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type required with owner_id and insight_id for the ID route.
string
Insight OID for the OID route. This route explicitly requires the Admin app permission; use it alone instead of the ID-route selectors.
string ("full" | "compact")
Response shape: full (the default) returns the full field definition; compact returns only the field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_ADD_PROJECT_APPROVAL_CATEGORYAdd an approval category to a Quire project by project ID or OID. The tool declares the Admin app permission as a requirement.

Input Parameters

object
required
Approval category to add.
string
Project ID for the ID route. Supply exactly one of project_id or project_oid. Quire assigns no named app permission to this route; normal project authorization still applies.
string
Project OID for the OID route. Supply exactly one of project_id or project_oid. This route explicitly requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) returns the full category; compact requests identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_ADD_PROJECT_FIELDAdd a custom-field definition to a Quire project by project ID or OID. The ID route has no named app permission in Quire’s specification and uses normal resource authorization. The OID route explicitly requires the Quire app’s Admin permission.

Input Parameters

object
required
Complete field definition to add.
string
Project ID for the ID route. Supply exactly one of project_id or project_oid. This route uses normal resource authorization and has no named app permission in Quire’s specification.
string
Project OID for the OID route. Supply exactly one of project_id or project_oid. This route explicitly requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) returns the full field definition; compact returns only the field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_ADD_TASK_TIMELOGAdd a time log to a Quire task identified by task OID or by project ID plus task ID. Returns the task’s complete, fixed-shape timelogs array.

Input Parameters

object
required
Time log to add to the task.
integer
Task ID. Supply together with project_id, or supply task_oid instead.
string
Task OID. Supply this alone, or supply project_id and task_id instead.
string
Project ID. Supply together with task_id, or supply task_oid instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_ATTACH_FILE_TO_COMMENTUpload a file as a raw-byte attachment to an existing Quire comment.

Input Parameters

object
required
File whose raw bytes will be attached to the comment.
string
required
Attachment filename, including a meaningful extension so clients can recognize its media type. Executable files may be rejected by project policy.
string
required
OID of the existing comment that will receive the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_ATTACH_FILE_TO_TASKUpload raw file bytes as an attachment to a task identified by ID or OID.

Input Parameters

object
required
File whose raw bytes will be attached to the task.
integer
Numeric task ID for the ID route. Supply together with project_id, or supply task_oid instead.
string
required
Attachment filename. Include a meaningful extension so clients can recognize its media type. Executable files may be rejected by project policy.
string
Task OID for the OID route. Do not combine it with ID-route fields.
string
Project ID for the ID route. Use ’-’ for a personal task in My Tasks. Supply together with task_id, or supply task_oid instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_CREATE_TASKSAtomically create one to 300 Quire root, child, or sibling tasks in submitted order. The body is a top-level array. Any item error rolls back the whole batch and retains its items[i]: index. Dry-run performs the same validation without persistence; its returned identifiers are disposable. Normal calls cost one rate-limit unit per item and dry runs cost ceil(items / 2), minimum one.

Input Parameters

array
required
One to 300 tasks sent as a top-level JSON array in submitted order.
string ("true" | "false")
Set to true to run all validation and permission checks without persisting. Dry-run identifiers are discarded. Cost is ceil(item count / 2), minimum one, rather than one rate-limit unit per item.
integer
Anchor task ID; requires project_id and selects the anchored-by-ID route.
string ("parent" | "before" | "after")
Placement relative to a task anchor; valid only with task_id or target_oid.
string
Project ID for a root or ID-anchored route; do not combine with target_oid.
string
Project or task OID selecting the OID route; do not combine with ID selectors.
string ("full" | "compact")
Response shape: full task records (default) or compact {oid, id} records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_DELETE_TASKSAtomically delete 1 to 300 Quire tasks from a project selected by ID or OID. The request and response are top-level arrays in submitted order. Malformed references and permission failures roll back the whole batch, while unresolved or already-deleted references produce null slots, making retries idempotent. Dry-run performs the same checks without persistence. Real calls cost one rate-limit unit per submitted item even when skipped; dry-runs cost max(1, ceil(items / 2)). The response is always identifier-only.

Input Parameters

array
required
One to 300 task references sent to Quire as a top-level JSON array. Each item may be a task OID, an integer task ID, or a ’#<id>’ string; forms may be mixed and order is preserved.
string ("true" | "false")
Set to true to perform the same validation and permission checks without deleting tasks. A successful preview can become stale after concurrent edits.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_oid or project_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_MOVE_TASKSAtomically move or reorder 1 to 300 Quire tasks within one project, selected by project ID or OID. Quire moves resolvable items in submitted order as a sliding chain, returns null for unresolved item references, and rolls back the entire batch on validation, permission, cycle, or database errors. Use dry_run to validate without persistence. A real request costs one rate-limit unit per item; dry-run costs max(1, ceil(items / 2)). Cross-project moves require the bulk-transfer tool.

Input Parameters

array
required
Ordered task references to move, from 1 to 300 items. Each item may be a task OID, an integer task ID, or a #<id> string; forms may be mixed. Quire receives this list as the top-level JSON array.
string
required
Destination anchor shared by the whole batch. Use root to move tasks to the project root. Otherwise use an integer task ID with project_id or a task OID with project_oid.
string ("true" | "false")
Set to true to run all validation and permission checks without persisting moves. A successful preview can become stale after concurrent edits.
string ("parent" | "before" | "after")
Placement relative to task: parent (default) makes the moved tasks children; before or after makes them siblings. root supports only the default parent position.
string
Project ID. Supply exactly one of project_id or project_oid. With this route, task must be an integer task ID encoded as a string or root.
string
Project OID. Supply exactly one of project_id or project_oid. With this route, task must be a task OID or root.
string ("full" | "compact")
Response shape sent as Quire’s return parameter. full is the default; compact returns task identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_SET_TASK_APPROVALSAtomically apply one approval transition to up to 300 Quire tasks in a project selected by ID or OID. Missing tasks preserve null result slots; any validation or permission failure rolls back the whole batch. Supports non-persisting dry runs and full or compact responses.

Input Parameters

array
required
Top-level array of one to 300 task references. Each item may be an integer task ID, a ’#<id>’ string, or a task OID; forms may be mixed. The request costs one rate-limit unit per item unless dry_run is true.
string ("request" | "approve" | "reject" | "change")
required
Approval transition for every task: request starts or renews approval, approve accepts it, reject declines it, and change requests changes.
string ("true" | "false")
Set to true to run the same validation and permission checks without persisting changes. A dry run costs ceil(task count / 2), minimum 1, instead of one rate-limit unit per task.
string
Approval category ID. Omit it to use the project’s default category, whose ID is an empty string.
string
Project ID. Supply either this field or project_oid, but not both.
string
Project OID. Supply either this field or project_id, but not both.
string ("full" | "compact")
Response shape. full returns task records with approval data; compact returns only each task’s OID and ID. Omission defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_TRANSFER_TASKSAtomically transfer 1 to 300 Quire tasks from one project to a different target project using ID or OID routing. The body is a top-level mixed-reference array. Transfers preserve OIDs, assign target-project IDs, and preserve submitted order; by default Quire may invite assignees and add or remap missing tags, statuses, and non-empty custom fields in the target project; set those controls to false to prevent those additional effects. unresolved source items produce null slots. Validation, permission, or database errors retain items[i]: and roll back both projects. Dry-run performs the same checks without persistence. Calls cost N units for N submitted items; dry-run costs ceil(N / 2), minimum one, charged before processing even for skipped items.

Input Parameters

string ("true" | "false")
Whether to auto-create missing tags in the target project; Quire defaults to true.
array
required
One to 300 task references sent as the top-level JSON array. Each item is a task OID, strict integer ID, or #<id> string; forms may be mixed.
string
Optional destination anchor in the target project: an integer task ID encoded as a string on the ID route, or a task OID on the OID route. Omit it, pass an empty string, or use root to place tasks at the root.
string ("true" | "false")
Whether to auto-invite assignees to the target project; Quire defaults to true.
string ("true" | "false")
Whether to auto-remap statuses to the target project; Quire defaults to true.
string ("true" | "false")
Set to true to perform the same source-and-target validation and permission checks without persisting in either project. A successful preview can become stale after concurrent edits.
string
required
Target project ID for the ID route or OID for the OID route. Use - for the authorizing user’s Inbox. It must resolve to a different project.
string ("parent" | "before" | "after")
Placement relative to task. parent is the default; before and after require a non-root destination task. Later successful items are placed after the previous successful transfer to preserve submitted order.
string ("true" | "false")
Whether to auto-create or remap non-empty custom fields in the target project; Quire defaults to true. Sent as custom-field.
string ("full" | "compact")
Response shape sent as return: full task records by default, or compact records containing the preserved OID and reassigned target-project ID.
string
Source project ID. Supply exactly one source selector. This route expects project and task to be target-project IDs.
string
Source project OID. Supply exactly one source selector. This route expects project and task to be target-project OIDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_BULK_UPDATE_TASKSAtomically update one to 300 Quire tasks in a project selected by ID or OID. Each item selects exactly one task by ID or OID and may apply the full task update surface, including flattened project custom fields and explicit nulls that clear supported values. Missing tasks preserve null response slots; any validation, permission, conflict, or database error rolls back the whole batch and identifies the failing items[i]. Supports non-persisting dry runs and full or compact responses. Real calls cost one rate-limit unit per item; dry runs cost max(1, ceil(items / 2)).

Input Parameters

array
required
One to 300 task updates sent as a top-level JSON array in submitted order. Each item selects exactly one task by oid or id.
string ("true" | "false")
Set to true to perform the same validation and permission checks without persisting. Dry runs cost max(1, ceil(item count / 2)) rate-limit units.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_id or project_oid.
string ("full" | "compact")
Response shape: full task records (default) or compact identifier records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_CHATCreate a chat under a project using its human-readable ID or OID.

Input Parameters

object
required
Chat channel to create.
string
Human-readable project ID. Supply exactly one of owner_id or owner_oid.
string
Project OID. Supply exactly one of owner_id or owner_oid.
string
Owner type. Quire currently supports only project.
string ("full" | "compact")
Response shape: full (the default) returns the chat record; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_CHAT_COMMENTAdd a Markdown comment to a chat identified by its OID or by project ID plus chat ID.

Input Parameters

object
required
Comment to create.
string
Chat channel ID for the ID route. Provide it together with project_id, or omit both when using chat_oid.
string
Chat channel OID. Provide this alone, or omit it and provide both project_id and chat_id.
string
Project ID for the ID route. Provide it together with chat_id, or omit both when using chat_oid.
string ("full" | "compact")
Response shape: full (default) returns the full comment record; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_DASHBOARDCreate a dashboard container under a project, organization, folder, or smart folder using the owner’s human-readable ID or OID. Dashboard widgets cannot be configured through this operation.

Input Parameters

object
required
Dashboard to create.
string
Owner ID. Supply exactly one of owner_id or owner_oid.
string
Owner OID. Supply exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Owner type: project, organization, folder, or smart-folder. Quire assumes project when the route segment is omitted.
string ("full" | "compact")
Response shape: full (the default) returns the full dashboard; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_DOCCreate a document under a project, organization, folder, or smart folder using the owner’s human-readable ID or OID.

Input Parameters

object
required
Document to create.
string
Human-readable owner ID. Supply exactly one of owner_id or owner_oid.
string
Owner OID. Supply exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type: project, organization, folder, or smart-folder. Defaults to project.
string ("full" | "compact")
Response shape: full (the default) returns the document record; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_INSIGHTCreate an insight view under a project, organization, folder, or smart folder using the owner’s human-readable ID or OID.

Input Parameters

object
required
Insight view to create.
string
Human-readable owner ID. Supply exactly one of owner_id or owner_oid.
string
Owner OID. Supply exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Owner type: project, organization, folder, or smart-folder.
string ("full" | "compact")
Response shape: full (the default) returns the full insight record; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_STATUSCreate a task status in a project identified by ID or OID.

Input Parameters

object
required
Task status to create.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_id or project_oid.
string ("full" | "compact")
Response shape: full (the default) returns the full status record; compact requests Quire’s compact representation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_SUBLISTCreate a sublist under a project, organization, folder, or smart folder using the owner’s human-readable ID or OID.

Input Parameters

object
required
Sublist to create.
string
Owner ID. Supply exactly one of owner_id or owner_oid.
string
Owner OID. Supply exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type: project, organization, folder, or smart-folder. Defaults to project.
string ("full" | "compact")
Response shape: full (the default) returns the full sublist; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_TAGCreate a tag in a project identified by ID or OID.

Input Parameters

object
required
Tag to create.
string
Project ID to add the tag to, or - for personal tasks. Supply exactly one of project_id or project_oid.
string
Project OID to add the tag to, or - for personal tasks. Supply exactly one of project_id or project_oid.
string ("full" | "compact")
Response shape: full (the default) returns the full tag record; compact requests Quire’s compact representation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_TASKCreate a Quire root task or a child/sibling task using a project ID, a project ID plus task ID, or a project/task OID. Supports nested subtasks and project-defined custom fields.

Input Parameters

object
required
Task to create.
integer
Referenced task ID; requires project_id and creates relative to that task.
string ("parent" | "before" | "after")
Placement relative to a task anchor: child (parent, the default), or sibling before or after. Valid only with task_id or a task OID.
string
Project ID for a root or ID-anchored route. Use - for My Tasks. Do not combine with target_oid.
string
Project or task OID selecting the OID route. A project creates a root task; a task creates relative to it. Use - for My Tasks.
string ("full" | "compact")
Response shape: full task record (default), or compact identifiers only (oid and id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_CREATE_TASK_COMMENTAdd a Markdown comment to a task identified by task OID or by project ID plus task ID.

Input Parameters

object
required
Comment to create.
integer
Task ID. Supply together with project_id, or supply task_oid instead.
string
Task OID. Supply this alone, or supply project_id and task_id instead.
string
Project ID. Supply together with task_id, or supply task_oid instead.
string ("full" | "compact")
Response shape: full (the default) returns the full comment; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_CHATRemove one Quire chat channel by its OID or by its owner ID and chat ID. Deletion is idempotent: Quire returns success even if the chat no longer exists. A deleted chat may be restorable with RESTORE_CHAT.

Input Parameters

string
Chat channel ID for ID-based lookup. Required with owner_type and owner_id; omit when using chat_oid.
string
Chat channel OID. Provide this alone, or omit it and provide the complete owner_type, owner_id, and chat_id route.
string
Owner ID for ID-based lookup. Required with owner_type and chat_id; omit when using chat_oid.
string
Owner type for ID-based lookup. Currently only project is supported. Required with owner_id and chat_id; omit when using chat_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_COMMENTRemove one Quire comment by its OID. Deletion is idempotent: Quire returns success even if the comment no longer exists. A deleted comment may be restorable with RESTORE_COMMENT when that action is available.

Input Parameters

string
required
OID of the comment to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_DASHBOARDRemove one Quire dashboard by its OID or by its owner ID and dashboard ID. Deletion is idempotent: Quire returns success even if the dashboard no longer exists. A deleted dashboard may be restorable with RESTORE_DASHBOARD.

Input Parameters

string
Owner ID for ID-based lookup. Required with owner_type and dashboard_id; omit when using dashboard_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for ID-based lookup. Required with owner_id and dashboard_id; omit when using dashboard_oid.
string
Dashboard ID for ID-based lookup. Required with owner_type and owner_id; omit when using dashboard_oid.
string
Dashboard OID. Provide this alone, or omit it and provide owner_type, owner_id, and dashboard_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_DOCRemove one Quire document by its OID or by its owner ID and document ID. Deletion is idempotent: Quire returns success even if the document no longer exists. A deleted document may be restorable with RESTORE_DOC.

Input Parameters

string
Document ID for ID-based lookup. Required with owner_type and owner_id; omit when using doc_oid.
string
Document OID. Provide this alone, or omit it and provide owner_type, owner_id, and doc_id.
string
Owner ID for ID-based lookup. Required with owner_type and doc_id; omit when using doc_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for ID-based lookup. Required with owner_id and doc_id; omit when using doc_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_INSIGHTRemove one Quire insight by its OID or by its owner ID and insight ID. Deletion is idempotent: Quire returns success even if the insight no longer exists.

Input Parameters

string
Owner ID for ID-based lookup. Required with owner_type and insight_id; omit when using insight_oid.
string
Insight ID for ID-based lookup. Required with owner_type and owner_id; omit when using insight_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for ID-based lookup. Required with owner_id and insight_id; omit when using insight_oid.
string
Insight OID. Provide this alone, or omit it and provide owner_type, owner_id, and insight_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_STATUSDelete one project task status by numeric value using the project ID or OID. The operation is idempotent: Quire returns 204 No Content even when the status does not exist.

Input Parameters

integer
required
Signed 32-bit numeric value of the status to delete.
string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_STORAGE_VALUEDelete one access-token-scoped app storage value by key name. The operation is idempotent: Quire returns 204 No Content whether or not the key exists.

Input Parameters

string
required
Key name of the access-token-scoped storage value to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_SUBLISTRemove one Quire sublist by its OID or by its owner ID and sublist ID. Deletion is idempotent: Quire returns success even if the sublist no longer exists.

Input Parameters

string
Owner ID for ID-based lookup. Required with owner_type and sublist_id; omit when using sublist_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for ID-based lookup. Required with owner_id and sublist_id; omit when using sublist_oid.
string
Sublist ID for ID-based lookup. Required with owner_type and owner_id; omit when using sublist_oid.
string
Sublist OID. Provide this alone, or omit it and provide owner_type, owner_id, and sublist_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_TAGDelete one Quire tag by its OID. The operation is idempotent: Quire returns 204 No Content even when the tag does not exist.

Input Parameters

string
required
OID of the tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_DELETE_TASKRemove one Quire task by task OID or by project ID plus numeric task ID. WARNING: Quire also removes every subtask beneath the selected task. The task may be recoverable with RESTORE_TASK while Quire retains the removed record. Deletion is idempotent: both routes return 204 No Content even when the task does not exist.

Input Parameters

integer
Numeric task ID for the ID route. Supply together with project_id, or supply task_oid alone.
string
Task OID for the OID route. Supply alone, or supply project_id and task_id instead.
string
Project ID for the ID route. Use - for a task in My Tasks. Supply together with task_id, or supply task_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_EXPORT_PROJECT_CSVExport a Quire project and its filtered tasks and related data as a CSV file, selecting the project by ID or OID. Requires the Professional plan or above. The request costs 5 + max(1, ceil(filtered tasks / 100)) rate-limit units.

Input Parameters

boolean
Whether to merge multiple values under the same header into one CSV column, such as placing all tags in one column.
string ("active" | "completed" | "all")
Task status filter. active exports active tasks, completed exports completed tasks, and all exports both. A narrower filter can reduce the request’s rate-limit cost.
string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_EXPORT_PROJECT_JSONExport a Quire project, all tasks, and related data as JSON by project ID or OID; redundant HTML fields are removed when corresponding source and text fields are present. Requires the Professional plan or above and costs 5 + max(1, ceil(tasks / 100)) rate-limit units.

Input Parameters

string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_CHATGet one chat by its OID or by owner ID plus resource ID.

Input Parameters

string
Chat channel ID. Required with owner_type and owner_id when chat_oid is omitted.
string
Chat channel OID. Use this alone, without the ID-route fields.
string
Owner ID. Required with owner_type and chat_id when chat_oid is omitted.
string
Owner type for the ID route. Currently only project is supported. Required with owner_id and chat_id when chat_oid is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_COMMENTGet one comment by its OID.

Input Parameters

string
required
Comment OID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_DASHBOARDGet one dashboard by its OID or by owner ID plus resource ID.

Input Parameters

string
Owner ID. Required with owner_type and dashboard_id when dashboard_oid is omitted.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Required with owner_id and dashboard_id when dashboard_oid is omitted.
string
Dashboard ID. Required with owner_type and owner_id when dashboard_oid is omitted.
string
Dashboard OID. Use this alone, without the ID-route fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_DOCGet one document by its OID or by owner ID plus resource ID.

Input Parameters

string
Document ID. Required with owner_type and owner_id when doc_oid is omitted.
string
Document OID. Use this alone, without the ID-route fields.
string
Owner ID. Required with owner_type and doc_id when doc_oid is omitted.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Required with owner_id and doc_id when doc_oid is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_INSIGHTGet one insight by OID or by owner ID plus insight ID.

Input Parameters

string
Owner ID. Required with owner_type and insight_id when insight_oid is omitted.
string
Insight ID. Required with owner_type and owner_id when insight_oid is omitted.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Required with owner_id and insight_id when insight_oid is omitted.
string
Insight OID. Use this alone, without the ID-route fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_ORGANIZATIONGet organization details by ID or OID, including subscription plan when available.

Input Parameters

string
Organization ID. Provide exactly one of organization_id or organization_oid.
string
Organization OID. Provide exactly one of organization_id or organization_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_PARTNERGet one external team partner by OID.

Input Parameters

string
required
External team OID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_PROJECTGet one complete project record by ID or OID, including plan details.

Input Parameters

string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_RATE_LIMITReturn current minute and hourly API usage for an organization or personal project by ID or OID. This inspection request consumes no rate-limit units.

Input Parameters

string
Organization or personal-project ID. Provide exactly one of target_id or target_oid.
string
Organization or personal-project OID. Provide exactly one of target_id or target_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_STATUSGet one project task status by numeric value.

Input Parameters

integer
required
Non-negative numeric value of the status to fetch.
string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_STORAGE_VALUEGet one application storage value by key name. Values are scoped to the connected Quire access token and returned without changing their JSON type.

Input Parameters

string
required
Storage key name scoped to the connected Quire access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_SUBLISTGet one sublist by its OID or by owner ID plus resource ID.

Input Parameters

string
Owner ID. Required with owner_type and sublist_id when sublist_oid is omitted.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Required with owner_id and sublist_id when sublist_oid is omitted.
string
Sublist ID. Required with owner_type and owner_id when sublist_oid is omitted.
string
Sublist OID. Use this alone, without the ID-route fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_TAGReturn one tag identified by its OID.

Input Parameters

string
required
OID of the tag to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_TASKGet one complete Quire task by task OID or by project ID plus numeric task ID. Returns identifiers, Markdown and plain-text content, relationships, assignment, scheduling, status, approval, time-log, attachment, and audit data.

Input Parameters

integer
Numeric task ID. Supply together with project_id, or supply task_oid alone.
string
Task OID. Supply this alone, or supply project_id and task_id instead.
string
ID of the task’s project. Use - for a personal task in My Tasks. Supply together with task_id, or supply task_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_GET_USERGet a user by human-readable ID, email address, me, or OID.

Input Parameters

string
User ID, email address, or me. Provide exactly one of user_id or user_oid.
string
User OID. Provide exactly one of user_id or user_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_CHAT_COMMENTSList all comments on a chat identified by chat OID or by project ID plus chat ID.

Input Parameters

string
Chat channel ID. Provide this with project_id, or provide chat_oid alone.
string
Chat channel OID. Provide this alone, without project_id or chat_id.
string
Project ID. Provide this with chat_id, or provide chat_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_CHATSList chats under a supported owner identified by ID or OID.

Input Parameters

string
Project ID. Provide exactly one of owner_id or owner_oid.
string
Project OID. Provide exactly one of owner_id or owner_oid.
string
required
Owner type. Quire currently supports only project for chat owners.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_DASHBOARDSList dashboards under a supported owner identified by ID or OID.

Input Parameters

string
Owner ID. Provide exactly one of owner_id or owner_oid.
string
Owner OID. Provide exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Type of owner whose dashboards to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_DOCSList documents under a supported owner identified by ID or OID. Quire returns each document’s full Markdown body plus rendered text and HTML, so results may be large.

Input Parameters

string
Owner ID. Provide exactly one of owner_id or owner_oid.
string
Owner OID. Provide exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Type of owner whose documents to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_INSIGHTSList insights under an owner identified by ID or OID.

Input Parameters

string
Owner ID. Provide exactly one of owner_id or owner_oid.
string
Owner OID. Provide exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Type of owner whose insights to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_ORGANIZATIONSList organizations visible to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_PROJECT_PARTNERSList external team partners for a project identified by ID or OID.

Input Parameters

string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_PROJECTSList projects authorized for the current application, globally or within one organization selected by ID or OID, with optional archived and add-task filters.

Input Parameters

boolean
Whether to return only projects to which the current user can add tasks.
boolean
Whether to include archived projects; Quire excludes them by default.
string
Organization ID used to restrict results. Do not also provide organization_oid.
string
Organization OID used to restrict results. Do not also provide organization_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_STATUSESList task statuses for a project identified by ID or OID.

Input Parameters

string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_STORAGE_VALUESList up to 20 app storage values ordered by key, either across all keys or restricted to a prefix. Returns an object whose dynamic keys are storage names and whose values may be any JSON value; empty storage returns {}.

Input Parameters

string
Key prefix to match. Omit it to list all stored values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_SUBLISTSList sublists under a supported owner identified by ID or OID.

Input Parameters

string
Owner ID. Provide exactly one of owner_id or owner_oid.
string
Owner OID. Provide exactly one of owner_id or owner_oid.
string ("project" | "organization" | "folder" | "smart-folder")
required
Type of owner whose sublists to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_TAGSList tags in a project identified by ID or OID.

Input Parameters

string
Project ID. Provide exactly one of project_id or project_oid. Use ”-” for personal tasks.
string
Project OID. Provide exactly one of project_id or project_oid. Use ”-” for personal tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_TASK_COMMENTSList all comments on a task identified by task OID or by project ID plus task ID.

Input Parameters

integer
Integer task ID. Provide this together with project_id, or provide task_oid instead.
string
Task OID. Provide this alone, without project_id or task_id.
string
Project ID. Provide this together with task_id, or provide task_oid instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_TASKSList Quire project roots or a task’s direct children or paid deep subtree by project/task ID or OID. Supports status filtering, full or compact records, and one-page opaque cursor continuation. Deep traversal requires Professional or above and is capped at 500 nodes on Professional, 2,000 on Premium, and the response-size limit on Enterprise; cropped markers identify partial levels.

Input Parameters

string
Subtree depth for a parent task: a positive integer or full. Omit for direct children. Values above 1 and full require Professional or above and cannot be combined with limit or cursor.
string
Page size from 1 through 1000, or no to explicitly return all tasks. Omitting it returns the complete flat list. Task-list rate-limit cost is max(1, ceil(items returned / 100)).
string
Opaque cursor returned by the previous call. It restores the same target, limit, status, depth, and response format; do not construct or modify it.
string
Task status filter: active, completed, or an integer from 0 through 100.
integer
Parent task’s numeric ID; requires project_id.
string
Project ID whose root tasks to list. Add task_id to list a task’s children instead. Use - for My Tasks. Do not combine with target_oid.
string
Project OID whose roots to list, or parent-task OID whose children to list. Use - for My Tasks. Do not combine with project_id or task_id.
string ("full" | "compact")
Response shape. full returns task records; compact returns IDs/OIDs plus cursor, nested tasks, and cropped markers when applicable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_LIST_USERSList users visible to the app globally or within a project selected by ID or OID. The optional contacts permission controls which colleagues and member details are visible; the current user is always first.

Input Parameters

string
Project ID used to list project members. Omit both selectors to list globally.
string
Project OID used to list project members. Omit both selectors to list globally.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_MOVE_INSIGHT_FIELDReorder a custom field on an insight identified by OID or by owner ID plus insight ID. Omit before to move it to the end. The OID route requires the Quire app’s Admin permission.

Input Parameters

string
Exact name of the field to place this field immediately before. Omit to move the field to the end.
string
Owner ID for the ID route. Provide with owner_type and insight_id.
string
required
Exact name of the custom field to move.
string
Insight ID for the ID route. Provide with owner_type and owner_id.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and insight_id; omit when using insight_oid.
string
Insight OID. Use this alone instead of the ID-route selectors. This route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_MOVE_PROJECT_FIELDReorder a custom field on a Quire project identified by ID or OID. Omit before to move the field to the end. The OID route requires the Quire app’s Admin permission.

Input Parameters

string
Exact name of the field to place this field immediately before. Omit to move the field to the end.
string
required
Exact name of the custom field to move.
string
Project ID. Provide exactly one of project_id or project_oid.
string
Project OID. Provide exactly one of project_id or project_oid. The OID route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_MOVE_TASKReparent or reorder one Quire task within its current project, selected by project ID plus numeric task ID or by task OID. Move it under a destination task, immediately before or after that task, or to the project root.

Input Parameters

string
required
Destination reference. Use root to move to the project root. Otherwise use an integer task ID with project_id and task_id, or a task OID with task_oid.
integer
Numeric ID of the task to move; supply it with project_id.
string ("parent" | "before" | "after")
Placement relative to task: parent (the default) makes the moved task a child; before or after makes it a sibling. root supports only the default parent placement.
string
OID of the task to move; do not combine it with ID-route fields.
string
Project ID for the ID route; use - for a personal task in My Tasks. Supply it with task_id, or supply task_oid alone.
string ("full" | "compact")
Response shape sent as Quire’s return query parameter. full is the default; compact returns task identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_REMOVE_INSIGHT_FIELDRemove a named custom field from a Quire insight by OID or by owner ID plus insight ID. The OID route requires the Quire app’s Admin permission. Removal is idempotent: Quire returns success when the field is already absent.

Input Parameters

string
Owner ID for the ID route. Required with owner_type and insight_id; omit when using insight_oid.
string
required
Exact name of the custom field to remove from the insight view.
string
Insight ID for the ID route. Required with owner_type and owner_id; omit when using insight_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Required with owner_id and insight_id; omit when using insight_oid.
string
Insight OID. Provide this alone instead of the ID-route selectors. The OID route requires the Quire app’s Admin permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_REMOVE_PROJECT_APPROVAL_CATEGORYRemove an approval category from a Quire project by project ID or OID. Any task approval that references the category is cleared. The ID route uses normal resource authorization; the OID route requires the Quire app’s Admin permission. Removal is idempotent: Quire returns success when the category is already absent.

Input Parameters

string
required
Exact ID of the approval category to remove from the project.
string
Project ID for the ID route. Provide exactly one of project_id or project_oid. This route uses normal Quire resource authorization.
string
Project OID for the OID route. Provide exactly one of project_oid or project_id. This route requires the Quire app’s Admin permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_REMOVE_PROJECT_FIELDRemove a named custom field from a Quire project by project ID or OID. The ID route uses normal resource authorization; the OID route requires the Quire app’s Admin permission. Removal is idempotent: Quire returns success when the field is already absent.

Input Parameters

string
required
Exact name of the custom field to remove from the project.
string
Project ID for the ID route. Provide exactly one of project_id or project_oid. This route uses normal Quire resource authorization.
string
Project OID for the OID route. Provide exactly one of project_oid or project_id. This route requires the Quire app’s Admin permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_REMOVE_TASK_TIMELOGRemove the task time log matching an exact start, end, and optional user, identifying the task by OID or by project ID plus integer task ID. Quire truncates sub-second timestamp precision before matching and returns all remaining time logs.

Input Parameters

string
required
Exact UTC ISO 8601 end timestamp of the time log to remove. Quire truncates sub-second precision before matching.
string
User credited with the time log. Omit to match a log credited to the authenticated caller.
string
required
Exact UTC ISO 8601 start timestamp of the time log to remove. Quire truncates sub-second precision before matching.
integer
Integer task ID for the ID route. Provide it with project_id, or provide task_oid alone.
string
Task OID for the OID route. Provide it alone instead of project_id and task_id.
string
Project ID for the ID route. Provide it with task_id, or provide task_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RENAME_INSIGHT_FIELDRename a custom field on an insight identified by OID or by owner ID plus insight ID while preserving the field’s content. The OID route requires the Quire app’s Admin permission.

Input Parameters

string
required
New name for the custom field.
string
Owner ID for the ID route. Provide with owner_type and insight_id.
string
required
Exact current name of the custom field.
string
Insight ID for the ID route. Provide with owner_type and owner_id.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and insight_id; omit when using insight_oid.
string
Insight OID. Use this alone instead of the ID-route selectors. This route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) or compact for the field name only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RENAME_PROJECT_FIELDRename a custom field on a project identified by ID or OID while preserving the field content and migrating task values. The OID route requires the Quire app’s Admin permission.

Input Parameters

string
required
New name for the custom field.
string
required
Exact current name of the custom field.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_id or project_oid. The OID route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) or compact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_CHATRestore a previously removed chat by its OID or by owner ID plus resource ID.

Input Parameters

string
Chat channel ID. Provide with owner_type and owner_id, or use chat_oid instead.
string
Chat channel OID. Provide this alone instead of the ID-route fields.
string
Owner ID. Provide with owner_type and chat_id, or use chat_oid instead.
string
Owner type for the ID route. Quire currently supports only project.
string ("full" | "compact")
Response shape: full for the complete chat record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_COMMENTRestore a previously removed comment by OID.

Input Parameters

string
required
Comment OID.
string ("full" | "compact")
Response shape: full for the complete comment record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_DASHBOARDRestore a previously removed dashboard by its OID or by owner ID plus resource ID.

Input Parameters

string
Owner ID for the ID route. Provide with owner_type and dashboard_id; omit when using dashboard_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and dashboard_id; omit when using dashboard_oid.
string
Dashboard ID for the ID route. Provide with owner_type and owner_id; omit when using dashboard_oid.
string
Dashboard OID. Provide this alone instead of the ID-route fields.
string ("full" | "compact")
Response shape: full for the complete dashboard record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_DOCRestore a previously removed document by its OID or by owner ID plus resource ID.

Input Parameters

string
Document ID for the ID route. Provide with owner_type and owner_id; omit when using doc_oid.
string
Document OID. Provide this alone instead of the ID-route fields.
string
Owner ID for the ID route. Provide with owner_type and doc_id; omit when using doc_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and doc_id; omit when using doc_oid.
string ("full" | "compact")
Response shape: full for the complete document record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_INSIGHTRestore a previously removed insight by its OID or by owner ID plus insight ID. If the insight is not removed, Quire returns it unchanged.

Input Parameters

string
Owner ID for the ID route. Provide with owner_type and insight_id; omit when using insight_oid.
string
Insight ID for the ID route. Provide with owner_type and owner_id; omit when using insight_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and insight_id; omit when using insight_oid.
string
Insight OID. Provide this alone instead of the ID-route fields.
string ("full" | "compact")
Response shape: full for the complete insight record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_SUBLISTRestore a previously removed sublist by its OID or by owner ID plus resource ID.

Input Parameters

string
Owner ID for the ID route. Provide with owner_type and sublist_id; omit when using sublist_oid.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route. Provide with owner_id and sublist_id; omit when using sublist_oid.
string
Sublist ID for the ID route. Provide with owner_type and owner_id; omit when using sublist_oid.
string
Sublist OID. Provide this alone instead of the ID-route fields.
string ("full" | "compact")
Response shape: full for the complete sublist record or compact for identifiers only. Defaults to full.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RESTORE_TASKRestore a previously removed Quire task by project ID plus numeric task ID, or by task OID. Restoring an active task is an idempotent no-op.

Input Parameters

integer
Numeric task ID for the ID route; supply it with project_id.
string
Task OID for the OID route; do not combine it with ID-route fields.
string
Project ID for the ID route; use - for a personal task in My Tasks. Supply it with task_id, or supply task_oid alone.
string ("full" | "compact")
Response shape: full (default) returns the restored task record; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_REVOKE_TASK_APPROVALCancel a Quire task’s current approval by task OID or by project ID plus integer task ID. For awaiting or changes states, Quire clears the approval. For approved or rejected states, Quire rolls it back to awaiting and preserves the original requester. Call the action again to clear that approval. The operation is idempotent when no approval is set.

Input Parameters

integer
Integer task ID for the ID route. Provide it with project_id, or provide task_oid alone.
string
Task OID for the OID route. Provide it alone instead of project_id and task_id.
string
Project ID for the ID route. Provide it with task_id, or provide task_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_RUN_INSIGHTRun a project-scoped insight by OID or by project ID plus insight ID and return its computed grouped table. Available on every Quire plan. A run costs 1 + max(0, ceil(tasks loaded / 250) - 1) rate-limit units after the status filter. Rows sort by group name, with the null group last. Project-wide task-collection tokens in formula columns evaluate to null; other cells in the row remain available.

Input Parameters

string ("active" | "completed" | "all")
Task-state filter applied before aggregation. active selects not-yet-completed tasks, completed selects completed tasks, and all does not filter by state. Narrower queries load fewer tasks and can cost fewer rate-limit units. Values are case-insensitive upstream.
string ("member" | "section")
Row grouping. member returns one row per assignee and includes multi-assignee tasks in every applicable group; section returns one row per section ancestor. Unassigned or sectionless tasks use a null group. Values are case-insensitive upstream.
string
Project ID. Required with owner_type and insight_id for the ID route.
string
Insight ID. Required with owner_type and owner_id for the ID route.
string
Owner type for the ID route. Must be project when using IDs.
string
Insight OID. Use this alone instead of the ID-route fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_SEARCH_TASKSSearch tasks in one project, folder, or organization selected by ID or OID. Supports each route’s documented full-text, regex, people, tag, activity, date, project-only, and project-ID-only filters, including dynamic project custom fields. Returns one page and exposes Quire’s documented cursor. Folder and organization searches require Professional or above. Rate-limit cost is max(1, ceil(items returned / 100)).

Input Parameters

string
Due date/time filter using the same relative, null, comparison, date, timestamp, and range grammar as start.
string
Tag OID/name expression using , (AND), &#124; (OR), or ! (NOT). Quote names containing operators or whitespace; escape quotes as \" and backslashes as \\.
boolean
Return only My Tasks: assigned to the current user, or created by the current user, scheduled, and unassigned.
string
Task name filter. Prefix with ~ for regex or ~* for case-insensitive regex.
string
Full-text query against task name, description, and attachments. It does not search comments, and indexing can lag updates by 10 seconds or more.
string
Maximum tasks to return as a positive integer string, or no for all matches. The default is 30; free plans permit at most 30 or no.
string
Start date/time filter: a relative keyword, isNull/isNotNull, a comparison with YYYY-MM-DD or an ISO 8601 UTC timestamp, or an inclusive between/notBetween pair.
string
editedAt filter using the created timestamp grammar. Never-edited tasks are excluded by every edited operation.
string
Task status: an integer from 0 through 100, active, or completed.
string
createdAt filter: a relative keyword such as today or last7d, a comparison (ge, gt, le, lt, eq, ne) with an ISO 8601 UTC timestamp, or an inclusive between/notBetween timestamp pair.
string
Project searches only: task sublist ID or OID filter.
string
toggledAt filter using the archived timestamp grammar, including isNull and isNotNull.
string
archivedAt filter using the created timestamp grammar, also supporting isNull and isNotNull.
string
Assignee expression using user OIDs, IDs, or emails. Combine values with , for AND, &#124; for OR, and ! for NOT; AND binds tighter than OR.
string
Assignor expression using user OIDs, IDs, or emails and , (AND), &#124; (OR), or ! (NOT).
string
Follower expression using user OIDs, IDs, or emails and , (AND), &#124; (OR), or ! (NOT).
string
Return tasks created or modified recently. Use an integer number of days or a value with d, h, or m, such as 8h.
string
Project-ID searches only: priority expression using -1 through 2 or low, medium, high, urgent, or none with ,, &#124;, and !.
string
Return tasks with recent comments. Use an integer number of days or a value with d, h, or m, such as 8h.
string
Project-ID searches only: true or an empty string for recurring tasks, or false for non-recurring tasks.
boolean
True returns tasks with a start or due date; false returns tasks with neither date set.
string
Project-ID searches only: task type expression using normal/task, section, or milestone with ,, &#124;, and !.
string
Project-ID searches only: creator expression using a user OID, ID, or email with ,, &#124;, and !.
string ("project" | "folder" | "organization")
required
Container type whose tasks to search.
string
Filter by the task’s sourceRef key.
string
reshowAt filter using the archived timestamp grammar, including isNull and isNotNull.
string
Task description filter. Prefix with ~ for regex or ~* for case-insensitive regex.
string
Opaque cursor from the previous page. Re-pass the same limit and filters; cannot be combined with sublist.
object
Project-ID searches only: map custom field names to typed filter values. Number, Money, Duration, and Date support ge/gt/le/lt/eq/ne, between/notBetween, isNull, and isNotNull. Checkbox uses booleans; Select uses option names; User uses an ID/email/OID; Task uses an ID/OID; Email and Hyperlink support exact, ~ regex, or ~* case-insensitive regex. Duration operands accept seconds or d/h/m suffixes. Date operands use YYYY-MM-DD or ISO 8601 UTC timestamps. Text, Formula, File, and Lookup custom fields are unsupported.
string ("id" | "oid")
Whether scope_identifier is a human-readable ID or OID.
string
required
Project, folder, or organization ID/OID matching scope_type and identifier_type. Use - for My Tasks when searching a project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_SEND_NOTIFICATIONIrreversibly send a Quire notification to the authorizing user, selected visible users, or every user visible to the app. Sending cannot be undone. Using recipients=[’*’] is a broadcast to all visible users, whose breadth depends on whether the app has access-to-contacts permission.

Input Parameters

object
required
Notification payload to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_SET_STORAGE_VALUECreate or replace one access-token-scoped app storage value by key. The value may be an object, array, string, number, or boolean. Use DELETE_STORAGE_VALUE to delete a key. New keys are subject to the Quire plan’s storage record cap, and each write is limited to 4 KiB.

Input Parameters

string
required
Complete JSON value to store. Objects, arrays, strings, numbers, booleans, are accepted. Use DELETE_STORAGE_VALUE to delete a key. Each write is limited to 4 KiB.
string
required
Key name whose access-token-scoped storage value will be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_SET_TASK_APPROVALRequest, approve, reject, or request changes for a task approval category, selecting the task by OID or by project ID plus task ID. The caller must be an allowed claimer to request approval or an allowed approver to decide it. Optionally creates a prefixed companion comment; use the revoke-approval action instead to cancel an approval.

Input Parameters

object
Optional companion comment. Omit this object to record only the approval transition; the created comment is not included in this response.
string ("request" | "approve" | "reject" | "change")
required
Approval transition: request approval, approve it, reject it, or request changes. A request can also return a decided approval to awaiting.
integer
Numeric task ID. Supply together with project_id, or supply task_oid instead.
string
Approval category ID. Omit to use the project’s default category, whose ID is the empty string.
string
Task OID. Supply this alone, or supply project_id and task_id instead.
string
Project ID. Supply together with task_id, or supply task_oid instead.
string ("full" | "compact")
Response shape: full (the default) returns approval details; compact returns the task’s OID and numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_TRANSFER_TASKTransfer one existing Quire task from its current project to a different project using an ID or OID route. The transfer removes it from the source project, preserves its OID, assigns a new numeric ID from the target project, and can place it at the target root or relative to a target task. By default, Quire may invite assignees and add missing tags, statuses, and non-empty custom fields to the target project; set the corresponding controls to false to prevent those side effects.

Input Parameters

string ("true" | "false")
Whether Quire may add missing task tags to the target project. Quire defaults to true.
string
Optional destination task in the target project: a numeric task ID encoded as a string on the ID route, or a task OID on the OID route. Omit it, pass an empty string, or use root to place the transferred task at the root.
string ("true" | "false")
Whether Quire may invite assignees who are not members of the target project. Quire defaults to true.
string ("true" | "false")
Whether Quire may add missing task statuses to the target project. Quire defaults to true.
string
required
Different target project: an ID when using project_id and task_id, or an OID when using task_oid. Use - for My Tasks. Transfer removes the task from its current project and assigns it a target-project numeric ID.
integer
Numeric task ID for the ID route; supply it with project_id.
string ("parent" | "before" | "after")
Placement relative to task. parent is the default and makes the transferred task a child; before or after makes it a sibling and requires a non-root destination task.
string
Task OID for the OID route; do not combine it with ID-route fields.
string
ID of the task’s current project. Use - for My Tasks. Supply this with task_id, or supply task_oid alone.
string ("true" | "false")
Whether Quire may add missing non-empty custom fields to the target project. Quire defaults to true; sent as custom-field.
string ("full" | "compact")
Response shape sent as return: full (default) returns the updated task record; compact returns its preserved OID and reassigned numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_CHATUpdate one chat by its OID or by owner ID plus resource ID.

Input Parameters

object
required
Fields to update; omitted fields preserve their existing values.
string
Chat channel ID. Required with owner_type and owner_id for the ID route.
string
Chat channel OID. Use this alone instead of the ID-route selectors.
string
Owner project ID. Required with owner_type and chat_id for the ID route.
string
Owner type for the ID route. Currently only project is supported.
string ("full" | "compact")
Response shape: full (default) or identifiers-only compact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_COMMENTUpdate the Markdown content or pin state of a comment by OID.

Input Parameters

object
required
Comment fields to update; omitted fields preserve their existing values.
string
required
Comment OID.
string ("full" | "compact")
Response shape: full (the default) returns the full comment; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_DASHBOARDUpdate one dashboard by its OID or by owner ID plus resource ID.

Input Parameters

object
required
Dashboard fields to update; omitted fields preserve existing values.
string
Owner ID. Required with owner_type and dashboard_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route: project, organization, folder, or smart-folder. Required with owner_id and dashboard_id.
string
Dashboard ID. Required with owner_type and owner_id for the ID route.
string
Dashboard OID. Use this alone instead of the ID-route selectors.
string ("full" | "compact")
Response shape: full (the default) for the complete dashboard or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_DOCUpdate one document by its OID or by owner ID plus resource ID.

Input Parameters

object
required
Document fields to update; omitted fields preserve existing values.
string
Document ID. Required with owner_type and owner_id for the ID route.
string
Document OID. Use this alone instead of the ID-route selectors.
string
Owner ID. Required with owner_type and doc_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route: project, organization, folder, or smart-folder. Required with owner_id and doc_id.
string ("full" | "compact")
Response shape: full (the default) for the complete document or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_INSIGHTUpdate one insight by OID or by owner ID plus insight ID.

Input Parameters

object
required
Insight fields to update; omitted fields preserve existing values.
string
Owner ID. Required with owner_type and insight_id for the ID route.
string
Insight ID. Required with owner_type and owner_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route: project, organization, folder, or smart-folder. Required with owner_id and insight_id.
string
Insight OID. Use this alone instead of the ID-route selectors.
string ("full" | "compact")
Response shape: full (the default) for the complete insight or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_INSIGHT_FIELDUpdate an existing custom-field definition on a Quire insight by OID or by owner ID plus insight ID. Omitted properties preserve current values; the field type is immutable. The OID route requires the Quire app’s Admin permission. Use the dedicated rename or move actions to rename or reorder a field.

Input Parameters

object
required
Field properties to update. Omitted properties preserve their current values, and individual flags are merged rather than replaced.
string
Owner ID required with owner_type and insight_id for the ID route.
string
required
Exact name of the existing custom field to update.
string
Insight ID required with owner_type and owner_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type required with owner_id and insight_id for the ID route.
string
Insight OID for the OID route. Use this alone instead of the ID-route selectors. This route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) returns the full field definition; compact returns only the field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_ORGANIZATIONUpdate organization properties by ID or OID.

Input Parameters

object
required
Organization fields to update; omitted fields remain unchanged.
string
Organization ID. Supply exactly one of organization_id or organization_oid.
string ("full" | "compact")
Response shape: full (the default) returns the complete organization; compact returns only its OID and ID.
string
Organization OID. Supply exactly one of organization_id or organization_oid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_PROJECTUpdate project properties by ID or OID, including visibility, followers, dates, and archive state.

Input Parameters

object
required
Project fields to update; omitted fields remain unchanged.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_id or project_oid.
string ("full" | "compact")
Response shape: full (the default) returns the complete project; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_PROJECT_APPROVAL_CATEGORYUpdate an approval category on a Quire project identified by ID or OID. Omitted changes preserve their current values. The ID route uses normal resource authorization; the OID route requires the Quire app’s Admin permission.

Input Parameters

object
required
Approval-category changes. Omitted properties preserve their current values; at least one property must be supplied.
string
required
Identifier of the approval category to update. The implicit default category has an empty identifier.
string
Project ID. Supply exactly one of project_id or project_oid. The ID route uses normal Quire resource authorization.
string
Project OID. Supply exactly one of project_id or project_oid. The OID route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) or compact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_PROJECT_FIELDUpdate an existing custom-field definition on a Quire project by ID or OID. Omitted properties preserve current values and the field type is immutable. The OID route requires the Quire app’s Admin permission; the ID route uses normal resource authorization and has no named app permission. Use the dedicated rename or move actions to rename or reorder a field.

Input Parameters

object
required
Field properties to update. Omitted properties preserve their current values, and individual flags are merged rather than replaced.
string
required
Exact name of the existing custom field to update.
string
Project ID. Supply exactly one of project_id or project_oid. This route uses normal resource authorization and has no named app permission in Quire’s specification.
string
Project OID. Use this alone instead of project_id. This route requires the Quire app’s Admin permission.
string ("full" | "compact")
Response shape: full (the default) returns the full field definition; compact returns only the field name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_STATUSUpdate one project task status by numeric value.

Input Parameters

object
required
Status fields to update. Omitted fields remain unchanged.
integer
required
Non-negative numeric value of the existing status to update.
string
Project ID. Supply exactly one of project_id or project_oid.
string
Project OID. Supply exactly one of project_id or project_oid.
string ("full" | "compact")
Response shape: full (the default) returns the complete status; compact requests Quire’s compact representation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_SUBLISTUpdate one sublist by its OID or by owner ID plus resource ID.

Input Parameters

object
required
Sublist fields to update; omitted fields preserve existing values.
string
Owner ID. Required with owner_type and sublist_id for the ID route.
string ("project" | "organization" | "folder" | "smart-folder")
Owner type for the ID route: project, organization, folder, or smart-folder. Required with owner_id and sublist_id.
string
Sublist ID. Required with owner_type and owner_id for the ID route.
string
Sublist OID. Use this alone instead of the ID-route selectors.
string ("full" | "compact")
Response shape: full (the default) for the complete sublist or compact for identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_TAGUpdate one tag by OID.

Input Parameters

object
required
Tag fields to update. Omitted fields remain unchanged.
string
required
OID of the tag to update.
string ("full" | "compact")
Response shape: full (the default) returns the complete updated tag; compact returns identifiers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_TASKPartially update one Quire task selected by project ID plus numeric task ID, or by task OID. Supports replacement and incremental relationship fields, recurrence, archive/snooze state, source references, and project-defined custom fields flattened into the task body.

Input Parameters

object
required
Task fields to update. Omitted fields remain unchanged; explicit nulls are retained for fields that support clearing.
integer
Numeric task ID for the ID route; supply it with project_id.
string
Task OID for the OID route; do not combine it with ID-route fields.
string
Project ID for the ID route; - selects personal My Tasks. Supply it with task_id, or supply task_oid alone.
string ("full" | "compact")
Response shape: full (default) returns the updated task; compact returns only its OID and numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: QUIRE_UPDATE_TASK_TIMELOGReplace fields on the task time log identified by its exact existing start, end, and optional user, selecting the task by project/task ID or task OID.

Input Parameters

string
required
End timestamp of the existing log in ISO 8601 UTC.
object
required
Replacement fields; omitted or null fields preserve existing values.
string
User credited on the existing log as an OID, ID, or email. Omit to identify a log belonging to the authenticated caller.
string
required
Start timestamp of the existing log in ISO 8601 UTC. Together with end and optional user, this identifies the log to update.
integer
Numeric task ID for the ID route. Supply it together with project_id, or supply task_oid alone.
string
Task OID for the OID route. Do not combine it with ID-route fields.
string
Project ID for the ID route. Supply it together with task_id, or supply task_oid alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not