Get entity workflows
GET/projects/{projectId}/entities/{entityId}/workflows
Base URL: https://api.tinkermode.com
Get a list of workflows for this entity.
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 | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
enabled | boolean | No | Filter by enabled status. | |
limit | integer | No | default: 25; min: 0 | Maximum number of workflows to return. |
search | string | No | Filter workflows by a case-insensitive substring match against name and description. | |
skip | integer | No | default: 0; min: 0 | Number of workflows to skip over. |
sortBy | string | No | Sort results by a single field in the format field (ascending) or field:desc (descending).
Supported fields: name, enabled, createdAt, updatedAt.
|
Responses
200 Successfully retrieved the workflows.
Content type: application/json
Represents an automation workflow definition attached to an entity instance.
An array of objects with the following shape:
| 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. | |||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
triggers | array<object> | No | List of triggers that can start this workflow. | |||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
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. |
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. |