This reference is generated from the same OpenAPI contract that validates gateway requests and responses. It currently contains 111 operations.
Download OpenAPI 3.1 JSON · API date 2026-08-03
/v1Describes the active Ceyu public API version.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · plan_required · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/meReturns the organization, scopes, version, and limits for this key.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · plan_required · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/organizations/{id}Retrieves the organization bound to the authenticated credential.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/membersLists organization members from the identity source of truth.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/teamsLists organization teams from WorkOS groups.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/api_keysLists organization API keys without exposing secret values.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/api_keysCreates an organization API key and returns its secret exactly once.
| Field | Type | Description and example |
|---|---|---|
name required | string | The name value accepted by this operation as string. example |
scopes required | array | The scopes value accepted by this operation as array. [] |
expires_at | integer | null | The expires at value accepted by this operation as integer | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/api_keys/{id}Revokes a key locally before permanently deleting it in WorkOS.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/usageReturns the current credential credit window and plan day limit.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/request_logs/{id}Retrieves seven-day diagnostic metadata for one request id.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/audit_logsLists retained organization audit entries without secret payload data.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
action | string | The action value accepted by this operation as string. example |
actor | string | The actor value accepted by this operation as string. example |
room | string | The room value accepted by this operation as string. example |
target | string | The target value accepted by this operation as string. example |
created_after | value | The created after value accepted by this operation as value. example |
created_before | value | The created before value accepted by this operation as value. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boardsLists organization boards with snapshot freshness metadata.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
include_archived | value | The include archived value accepted by this operation as value. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boardsCreates a board and its durable API service-user ownership record.
| Field | Type | Description and example |
|---|---|---|
name required | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}Retrieves one organization board by public or legacy room id.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}Updates board metadata with optional revision-based If-Match protection.
| Field | Type | Description and example |
|---|---|---|
name | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}Archives a board as a recoverable deletion and emits its deletion event.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/itemsLists a board's items from one complete, revision-bound materialized snapshot.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/items/{item_id}Retrieves one item from the board's currently published snapshot.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/membersLists board memberships from the tenant-scoped authorization mirror.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/membersAdds or re-shares a board with an active organization member.
| Field | Type | Description and example |
|---|---|---|
user required | string | The user value accepted by this operation as string. example |
role required | string | The role value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/members/{user_id}Changes a non-owner board membership in WorkOS and D1 consistently.
| Field | Type | Description and example |
|---|---|---|
role required | string | The role value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/boards/{id}/members/{user_id}Revokes a non-owner board membership in WorkOS and D1.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/workspacesLists active FlowTask workspaces in the authenticated organization.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/workspacesCreates a workspace through the synchronized operation protocol.
| Field | Type | Description and example |
|---|---|---|
title required | string | The human-readable title shown throughout Ceyu. Launch checklist |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/workspaces/{id}Retrieves one FlowTask workspace.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/workspaces/{id}Updates workspace metadata through the synchronized operation protocol.
| Field | Type | Description and example |
|---|---|---|
title | string | The human-readable title shown throughout Ceyu. Launch checklist |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projectsLists FlowTask projects with stable cursor pagination.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projectsCreates a project through the FlowTask operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name required | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
portfolio | string | null | The portfolio value accepted by this operation as string | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/portfoliosLists FlowTask portfolios with stable ID cursor pagination.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/portfoliosCreates a portfolio through the FlowTask operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name required | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/portfolios/{id}Retrieves one FlowTask portfolio.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/portfolios/{id}Updates selected portfolio fields.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
archived_at | integer | null | The archived at value accepted by this operation as integer | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/portfolios/{id}Deletes a portfolio and retains a synchronization tombstone.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columnsLists project columns in an organization workspace.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columnsCreates a project column through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project required | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
name required | string | The name value accepted by this operation as string. example |
position | number | The position value accepted by this operation as number. example |
color | string | null | The color value accepted by this operation as string | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columns/{id}Retrieves one project column.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columns/{id}Updates a project column without replacing it.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name | string | The name value accepted by this operation as string. example |
position | number | The position value accepted by this operation as number. example |
color | string | null | The color value accepted by this operation as string | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columns/{id}Deletes a project column through the synchronization protocol.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/columns/reorderReorders up to 100 project columns in one workspace revision.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project required | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
data required | array | The data value accepted by this operation as array. [] |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projects/{id}Retrieves one FlowTask project.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projects/{id}Updates selected project fields without replacing the object.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name | string | The name value accepted by this operation as string. example |
description | string | Long-form context preserved as plain text. Prepare the production release. |
portfolio | string | null | The portfolio value accepted by this operation as string | null. example |
archived_at | integer | null | The archived at value accepted by this operation as integer | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projects/{id}Deletes a project through a retained FlowTask tombstone.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasksLists FlowTask tasks with workspace and project filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
expand | string | The expand value accepted by this operation as string. example |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | array | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
status | string | array | The current lowercase status value; integrations must tolerate future values. in_progress |
assignee | string | array | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_before | value | Return tasks due before this Unix-second timestamp. 1785816400 |
is_archived | value | Choose archived or active tasks explicitly. false |
filter | string | The filter value accepted by this operation as string. example |
sort | string | The sort value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasksCreates a task through the FlowTask operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
column | string | null | The column value accepted by this operation as string | null. example |
title required | string | The human-readable title shown throughout Ceyu. Launch checklist |
description | string | Long-form context preserved as plain text. Prepare the production release. |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
priority | string | The current lowercase priority value. high |
assignee | string | null | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_at | integer | null | When the task is due as Unix seconds, or null when no deadline is set. 1785816400 |
completed_at | integer | null | The completed at value accepted by this operation as integer | null. example |
labels | array | The labels value accepted by this operation as array. [] |
custom_fields | object | The custom fields value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/countCounts matching tasks with a tenant-isolated 60-second cache.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | array | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
status | string | array | The current lowercase status value; integrations must tolerate future values. in_progress |
assignee | string | array | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_before | value | Return tasks due before this Unix-second timestamp. 1785816400 |
is_archived | value | Choose archived or active tasks explicitly. false |
filter | string | The filter value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{id}Retrieves one FlowTask task.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{id}Patches task fields with optional entity-revision If-Match.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
column | string | null | The column value accepted by this operation as string | null. example |
title | string | The human-readable title shown throughout Ceyu. Launch checklist |
description | string | Long-form context preserved as plain text. Prepare the production release. |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
priority | string | The current lowercase priority value. high |
assignee | string | null | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_at | integer | null | When the task is due as Unix seconds, or null when no deadline is set. 1785816400 |
completed_at | integer | null | The completed at value accepted by this operation as integer | null. example |
labels | array | The labels value accepted by this operation as array. [] |
custom_fields | object | The custom fields value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{id}Deletes a task and creates its synchronization tombstone.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/commentsLists comments for one FlowTask task.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/commentsCreates a comment attributed to the API service user.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
body required | string | The body value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/comments/{id}Retrieves one comment belonging to a FlowTask task.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/comments/{id}Updates a task comment through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
body required | string | The body value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/comments/{id}Deletes a task comment and retains a tombstone.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/dependenciesLists outgoing dependencies for one task.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/dependenciesCreates a dependency between tasks in the same project.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
to required | string | The to value accepted by this operation as string. example |
kind | string | The kind value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entriesLists FlowTask time entries with workspace and task filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
task | string | The task related to this resource. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entriesCreates a time entry through the FlowTask operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
task required | string | The task related to this resource. task_01JAZ8Y7M2 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
user | string | null | The user value accepted by this operation as string | null. example |
started_at | integer | null | The started at value accepted by this operation as integer | null. example |
ended_at | integer | null | The ended at value accepted by this operation as integer | null. example |
duration_ms | integer | The duration ms value accepted by this operation as integer. 1785730000 |
note | string | The note value accepted by this operation as string. example |
billable | boolean | The billable value accepted by this operation as boolean. true |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entries/{id}Retrieves one FlowTask time entry.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entries/{id}Updates selected time-entry fields.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
task | string | null | The task related to this resource. task_01JAZ8Y7M2 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
user | string | null | The user value accepted by this operation as string | null. example |
started_at | integer | null | The started at value accepted by this operation as integer | null. example |
ended_at | integer | null | The ended at value accepted by this operation as integer | null. example |
duration_ms | integer | The duration ms value accepted by this operation as integer. 1785730000 |
note | string | The note value accepted by this operation as string. example |
billable | boolean | The billable value accepted by this operation as boolean. true |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entries/{id}Deletes a time entry through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/saved_filtersLists team-visible saved filters without exposing private user filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/saved_filters/{id}Retrieves one team-visible saved filter.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/task_templatesLists task templates with optional workspace and project filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/task_templates/{id}Retrieves one task template.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/task_templates/{id}/instantiateCreates a task from a template with bounded field overrides.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project required | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
title | string | The human-readable title shown throughout Ceyu. Launch checklist |
assignee | string | null | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_at | integer | null | When the task is due as Unix seconds, or null when no deadline is set. 1785816400 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/project_templatesLists project templates in visible workspaces.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/project_templates/{id}Retrieves one project template.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/project_templates/{id}/instantiateCreates a project from a project template with an optional name override.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name | string | The name value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/billing_ratesLists workspace billing rates.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/billing_ratesCreates a billing rate through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
scope required | string | The scope value accepted by this operation as string. example |
currency required | string | The currency value accepted by this operation as string. example |
amount_minor required | integer | The amount minor value accepted by this operation as integer. 1785730000 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/expensesLists expenses from one explicit workspace with authenticated keyset pagination.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
category | string | The category value accepted by this operation as string. example |
user | string | The user value accepted by this operation as string. example |
from | string | The from value accepted by this operation as string. example |
to | string | The to value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/expensesCreates an idempotent draft expense and its audit event atomically.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
category required | string | The category value accepted by this operation as string. example |
expense_date required | string | The expense date value accepted by this operation as string. example |
currency required | string | The currency value accepted by this operation as string. example |
gross_amount_minor required | integer | The gross amount minor value accepted by this operation as integer. 1785730000 |
net_amount_minor | integer | null | The net amount minor value accepted by this operation as integer | null. example |
tax_amount_minor | integer | null | The tax amount minor value accepted by this operation as integer | null. example |
tax_rate_bp | integer | null | The tax rate bp value accepted by this operation as integer | null. example |
vendor | string | The vendor value accepted by this operation as string. example |
vendor_vat_id | string | null | The vendor vat id value accepted by this operation as string | null. example |
invoice_number | string | null | The invoice number value accepted by this operation as string | null. example |
payment_method | string | null | The payment method value accepted by this operation as string | null. example |
business_purpose | string | null | The business purpose value accepted by this operation as string | null. example |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
notes | string | The notes value accepted by this operation as string. example |
extra_fields | object | The extra fields value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/expenses/{id}Retrieves one organization-scoped expense.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/expenses/{id}Updates a draft expense with compare-and-swap revision protection.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
category | string | The category value accepted by this operation as string. example |
expense_date | string | The expense date value accepted by this operation as string. example |
currency | string | The currency value accepted by this operation as string. example |
gross_amount_minor | integer | The gross amount minor value accepted by this operation as integer. 1785730000 |
net_amount_minor | integer | null | The net amount minor value accepted by this operation as integer | null. example |
tax_amount_minor | integer | null | The tax amount minor value accepted by this operation as integer | null. example |
tax_rate_bp | integer | null | The tax rate bp value accepted by this operation as integer | null. example |
vendor | string | The vendor value accepted by this operation as string. example |
vendor_vat_id | string | null | The vendor vat id value accepted by this operation as string | null. example |
invoice_number | string | null | The invoice number value accepted by this operation as string | null. example |
payment_method | string | null | The payment method value accepted by this operation as string | null. example |
business_purpose | string | null | The business purpose value accepted by this operation as string | null. example |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
notes | string | The notes value accepted by this operation as string. example |
extra_fields | object | The extra fields value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/billing_rates/{id}Retrieves one workspace billing rate.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/billing_rates/{id}Updates selected billing-rate fields.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
scope | string | The scope value accepted by this operation as string. example |
currency | string | The currency value accepted by this operation as string. example |
amount_minor | integer | The amount minor value accepted by this operation as integer. 1785730000 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/invoice_draftsLists invoice drafts with optional workspace and project filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/invoice_draftsCreates an invoice draft through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project required | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
currency required | string | The currency value accepted by this operation as string. example |
net_amount_minor required | integer | The net amount minor value accepted by this operation as integer. 1785730000 |
tax_amount_minor required | integer | The tax amount minor value accepted by this operation as integer. 1785730000 |
gross_amount_minor required | integer | The gross amount minor value accepted by this operation as integer. 1785730000 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/invoice_drafts/{id}Retrieves one invoice draft.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/invoice_drafts/{id}Updates selected invoice-draft fields.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
currency | string | The currency value accepted by this operation as string. example |
net_amount_minor | integer | The net amount minor value accepted by this operation as integer. 1785730000 |
tax_amount_minor | integer | The tax amount minor value accepted by this operation as integer. 1785730000 |
gross_amount_minor | integer | The gross amount minor value accepted by this operation as integer. 1785730000 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projects/{id}/archiveArchives a project while preserving its synchronized history.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/projects/{id}/duplicateAtomically duplicates a project with up to 99 columns and tasks.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
name | string | The name value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/batchCreates up to 100 tasks in one serialized FlowTask commit.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
data required | array | The data value accepted by this operation as array. [] |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{id}/completeMarks a task done and records its completion time.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{id}/moveMoves a task to another project or compatible column atomically.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
column | string | null | The column value accepted by this operation as string | null. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/tasks/{task_id}/dependencies/{id}Removes an outgoing task dependency.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entries/startStarts a time entry using the server clock.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
task required | string | The task related to this resource. task_01JAZ8Y7M2 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
user | string | null | The user value accepted by this operation as string | null. example |
duration_ms | integer | The duration ms value accepted by this operation as integer. 1785730000 |
note | string | The note value accepted by this operation as string. example |
billable | boolean | The billable value accepted by this operation as boolean. true |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/time_entries/{id}/stopStops a running time entry and computes its duration from the server clock.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/exportsQueues a bounded task export as an NDJSON artifact.
| Field | Type | Description and example |
|---|---|---|
resource required | "tasks" | The resource value accepted by this operation as "tasks". tasks |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | array | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
status | array | The current lowercase status value; integrations must tolerate future values. in_progress |
assignee | array | Return tasks assigned to this user; repeat the parameter for OR. usr_01JAZ90H3K |
due_before | integer | Return tasks due before this Unix-second timestamp. 1785816400 |
is_archived | boolean | Choose archived or active tasks explicitly. false |
filter | string | The filter value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/jobs/{id}Retrieves an export job and a fresh one-hour R2 download URL when complete.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flowsLists automation flows with optional workspace and project filters.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
starting_after | string | Return objects whose stable identifier follows this identifier. task_01JAZ8Y7M2 |
ending_before | string | Return objects whose stable identifier precedes this identifier. task_01JAZ8Y7M2 |
fields | string | Return only these comma-separated fields and mark the response as selected. id,title,due_at |
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flowsCreates a validated automation draft through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
name required | string | The name value accepted by this operation as string. example |
graph required | object | The graph value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flows/{id}Retrieves one automation flow.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flows/{id}Updates a paused automation draft through the operation protocol.
| Field | Type | Description and example |
|---|---|---|
workspace | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
project | string | null | The containing project, or null when the resource is unassigned. prj_01JAZ8BC9D |
name | string | The name value accepted by this operation as string. example |
graph | object | The graph value accepted by this operation as object. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flows/{id}/previewPreviews one automation against a task and returns a short-lived activation token.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
task required | string | The task related to this resource. task_01JAZ8Y7M2 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flows/{id}/activateActivates an automation only after a fresh matching preview and explicit acknowledgements.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
preview_token required | string | The preview token value accepted by this operation as string. example |
scope_acknowledged required | true | The scope acknowledged value accepted by this operation as true. true |
ai_cost_acknowledged | boolean | The ai cost acknowledged value accepted by this operation as boolean. true |
mode | string | The mode value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_flows/{id}/pausePauses an automation flow with an auditable bounded reason.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
reason | string | The reason value accepted by this operation as string. example |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_runsLists automation runs inside one explicitly selected workspace.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
automation_flow | string | The automation flow value accepted by this operation as string. example |
task | string | The task related to this resource. task_01JAZ8Y7M2 |
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_runs/{id}Retrieves one automation run and bounded audit metadata.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/automation_runs/{id}/cancelCancels a queued, running, sleeping, or retrying automation run.
| Field | Type | Description and example |
|---|---|---|
workspace required | string | The workspace that owns the resource. ws_01JAZ8A4Q1 |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpointsLists webhook destinations configured for this organization.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpointsCreates a webhook destination and returns its secret once.
| Field | Type | Description and example |
|---|---|---|
url required | string | The public HTTPS destination that receives signed deliveries. https://hooks.example.com/ceyu |
event_types required | array | The event names delivered to this endpoint. ["flowtask.task.created"] |
exclude_own_events | boolean | The exclude own events value accepted by this operation as boolean. true |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · invalid_webhook_url · webhook_target_unavailable · webhook_verification_failed · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpoints/{id}Retrieves a webhook destination without exposing its secret.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpoints/{id}Updates a webhook URL, subscriptions, or delivery state.
| Field | Type | Description and example |
|---|---|---|
url | string | The public HTTPS destination that receives signed deliveries. https://hooks.example.com/ceyu |
event_types | array | The event names delivered to this endpoint. ["flowtask.task.created"] |
exclude_own_events | boolean | The exclude own events value accepted by this operation as boolean. true |
status | string | The current lowercase status value; integrations must tolerate future values. in_progress |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · invalid_webhook_url · webhook_target_unavailable · webhook_verification_failed · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpoints/{id}Permanently removes a webhook destination.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · invalid_webhook_url · webhook_target_unavailable · webhook_verification_failed · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/webhook_endpoints/{id}/rotate_secretRotates a webhook signing secret with a 24-hour overlap.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · invalid_webhook_url · webhook_target_unavailable · webhook_verification_failed · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/eventsLists retained webhook events for troubleshooting and replay.
| Field | Type | Description and example |
|---|---|---|
limit | value | The maximum number of objects to return, from 1 through 100. 20 |
cursor | string | The opaque continuation token returned by the previous page. cur_eyJ… |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · cursor_invalid · cursor_filter_mismatch · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/events/streamStreams new organization events over resumable Server-Sent Events.
| Field | Type | Description and example |
|---|---|---|
types[] required | array | The types[] value accepted by this operation as array. [] |
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/events/{id}Retrieves an event with every bounded webhook delivery attempt.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/events/{id}/resendSchedules a fresh delivery cycle for one retained webhook event.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error
/v1/events/{id}/replayStarts a new delivery cycle for a retained webhook event.
This operation has no request fields.
missing_api_key · invalid_api_key · invalid_access_token · credential_validation_unavailable · insufficient_scope · plan_required · invalid_query_parameter · resource_not_found · resource_deleted · resource_id_ambiguous · invalid_request_body · idempotency_key_required · invalid_idempotency_key · idempotency_key_reused · idempotency_in_progress · resource_conflict · endpoint_disabled · rate_limit_exceeded · rate_limit_unavailable · internal_error