workflows
Get Workflow
REST API
Endpoints
- public
- workspaces
- workflows
- triggers
- workflow-executions
- actions
- secrets
- schedules
- tags
- users
- organization
- editor
- registry-repositories
- registry-actions
- settings
- organization-secrets
- tables
- cases
- auth
workflows
Get Workflow
Return Workflow as title, description, list of Action JSONs, adjacency list of Action IDs.
GET
/
workflows
/
{workflow_id}
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"actions": {},
"object": {},
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"webhook": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"secret": "<string>",
"status": "online",
"entrypoint_ref": "<string>",
"filters": {},
"method": "GET",
"workflow_id": "<string>",
"url": "<string>"
},
"schedules": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"status": "online",
"cron": "<string>",
"inputs": {},
"every": "<string>",
"offset": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"timeout": 123,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"entrypoint": "<string>",
"static_inputs": {},
"expects": {},
"returns": "<any>",
"config": {
"environment": "default",
"timeout": 300
},
"alias": "<string>",
"error_handler": "<string>"
}
Authorizations
Path Parameters
Query Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"actions": {},
"object": {},
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"webhook": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"secret": "<string>",
"status": "online",
"entrypoint_ref": "<string>",
"filters": {},
"method": "GET",
"workflow_id": "<string>",
"url": "<string>"
},
"schedules": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"status": "online",
"cron": "<string>",
"inputs": {},
"every": "<string>",
"offset": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"timeout": 123,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"entrypoint": "<string>",
"static_inputs": {},
"expects": {},
"returns": "<any>",
"config": {
"environment": "default",
"timeout": 300
},
"alias": "<string>",
"error_handler": "<string>"
}