GET
/
api
/
v1
/
workflow
/
public
/
scheduled
curl --request GET \
  --url https://api.gocobalt.io/api/v1/workflow/public/scheduled \
  --header 'x-api-key: <api-key>'
{
    "docs": [
        {
            "_id": "65e1b187a9feec935ab46c31",
            "event_id": "65e1b187a9feec935ab46c30",
            "workflow": {
                "_id": "65e1b122a9feec935ab40a2e",
                "name": "Schedule",
                "description": "",
                "associated_application": {
                    "_id": "65c9ef72af613b7828322831",
                    "name": "Slack",
                    "icon": "https://cobalt-app-logos.s3.ap-south-1.amazonaws.com/slack/logo.png",
                    "description": "Slack is a platform for team communication: everything in one place, instantly searchable, available wherever you go. Offering instant messaging, document sharing and knowledge search for modern teams."
                }
            },
            "config_id": "3",
            "linked_account_id": "3",
            "environment": "test",
            "org_id": "65c9ef72f4b95fce32e8ccf8",
            "cron_patten": "*/6 * * * *",
            "inactive": true,
            "schedule_added_at": "2024-03-01T10:44:23.336Z",
            "updatedAt": "2024-03-01T11:06:39.308Z",
            "inactive_from": "2024-03-01T11:06:39.308Z",
            "id": "65e1b187a9feec935ab46c31",
            "triggered_instances": []
        }
    ],
    "totalDocs": 5,
    "limit": 10,
    "totalPages": 5,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": true,
    "prevPage": null,
    "nextPage": 2
}

This API fetches all the scheduled jobs.

​
Request description

​
Query Params

​
linked_account_id
string

Unique customer identification id. For Eg: markwood@some_email.com

​
limit
string

Limit number of results in a page.

​
page
string

Page number of the response.

​
Response description

​
_id
string

ID of the registered cron

​
event_id
string

Event ID

​
workflow
object

Information about the workflow with schedule

​
confg_id
string

Config ID for which cron is registered.

​
linked_account_id
string

Linked Account ID for which cron is registered

​
environment
string

Environment in which cron registered

​
org_id
string

Organization id

​
cron_pattern
string

Cron Pattern used for schedule register.

​
inactive
boolean

The schedule is inactive or not.

​
triggered_instances
array

Array of the instances triggered using this schedule.

​
schedule_added_at
string

Timestamp when schedule was added

​
updatedAt
string

Timestamp of schedule updation.

​
inactive_from
string

Timestamp since which the schedule is inactive.

{
    "docs": [
        {
            "_id": "65e1b187a9feec935ab46c31",
            "event_id": "65e1b187a9feec935ab46c30",
            "workflow": {
                "_id": "65e1b122a9feec935ab40a2e",
                "name": "Schedule",
                "description": "",
                "associated_application": {
                    "_id": "65c9ef72af613b7828322831",
                    "name": "Slack",
                    "icon": "https://cobalt-app-logos.s3.ap-south-1.amazonaws.com/slack/logo.png",
                    "description": "Slack is a platform for team communication: everything in one place, instantly searchable, available wherever you go. Offering instant messaging, document sharing and knowledge search for modern teams."
                }
            },
            "config_id": "3",
            "linked_account_id": "3",
            "environment": "test",
            "org_id": "65c9ef72f4b95fce32e8ccf8",
            "cron_patten": "*/6 * * * *",
            "inactive": true,
            "schedule_added_at": "2024-03-01T10:44:23.336Z",
            "updatedAt": "2024-03-01T11:06:39.308Z",
            "inactive_from": "2024-03-01T11:06:39.308Z",
            "id": "65e1b187a9feec935ab46c31",
            "triggered_instances": []
        }
    ],
    "totalDocs": 5,
    "limit": 10,
    "totalPages": 5,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": true,
    "prevPage": null,
    "nextPage": 2
}
Register Cron SchedulePause Cron Schedule