Get an entity workflow

GET/projects/{projectId}/entities/{entityId}/workflows/{workflowId}

Base URL: https://api.tinkermode.com

Return the workflow with the specified ID.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain the key of a user or service account with permissions to read entity workflows, or a project API key.

Path parameters

Name	Type	Required	Description
`projectId`	integer	Yes	The unique ID for a specified project.
`entityId`	string	Yes	Entity ID (unique within project)
`workflowId`	string	Yes	The unique ID of the workflow (MongoDB ObjectID hex string).

Responses

`200` Successfully retrieved the workflow.

Content type: application/json

Property Type Required Constraints Description

createdAt string No The time the workflow was created (ISO 8601).

description string No An optional description of the workflow.

enabled boolean No Whether the workflow is active and eligible to be triggered.

entityId string No The unique identifier for the entity the workflow belongs to.

id string No The unique identifier for the workflow (MongoDB ObjectID hex string, auto-generated).

name string No The display name of the workflow.

projectId integer No The unique identifier for the project the workflow belongs to.

revision integer No Monotonically increasing revision number, updated on every write.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Used by branching nodes (e.g. condition nodes) to define which steps to run for each outcome. Maximum nesting depth is 1.
`id`	string	No	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node. Supports template expressions referencing previous step outputs.
`node`	string	No	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	No		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string No Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string No one of: cron The trigger type. Currently only 'cron' is supported.

updatedAt string No The time the workflow was last updated (ISO 8601).

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` Workflow not found.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

Get an entity workflow

Authentication

Path parameters

Responses

200 Successfully retrieved the workflow.

401 Authorization is required to access this resource.

403 Request failed because of denied permission.

404 Workflow not found.

429 Request failed because of rate limit.

500 An unexpected error has occurred.

503 The service is temporarily unavailable.

`200` Successfully retrieved the workflow.

`401` Authorization is required to access this resource.

`403` Request failed because of denied permission.

`404` Workflow not found.

`429` Request failed because of rate limit.

`500` An unexpected error has occurred.

`503` The service is temporarily unavailable.