Scheduler Service
List schedules

1min
GET
/schedules
Header Parameters
X-COREOS-ACCESS
string
*
X-COREOS-APPID
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
Responses
200
Successful operation
ScheduleResponseList
schedules
object[]
meta
object
error
object
*
400
Bad Request
Curl
JS
Ruby
Python
curl --location '/schedules' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location '/schedules' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
// Successful operation 
{
  "schedules": [
    {
      "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
      "tenantId": "os1devs",
      "endpointUrl": "https://example.com/trigger",
      "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
      "payload": {},
      "startDate": "2023-08-30",
      "endDate": "2023-08-30",
      "cron": "* * * * *",
      "appId": "dispatch-fpa",
      "isActive": true,
      "TTL": 1695105095
    }
  ],
  "meta": {
    "hasNextPage": true,
    "nextPage": "os1devs.sandbox.getos1.com/core/api/v1/scheduler/schedules/schedule:dffae181-bd71-4566-96ae-d4e8a4f751a8/executions?page=dffae181-bd71-4566-96ae-d4e8a4f751a8"
  },
  "error": {}
}
// Successful operation 
{
  "schedules": [
    {
      "scheduleId": "schedule:89d03717-b21f-49bc-b3c9-cd1924cee5a2",
      "tenantId": "os1devs",
      "endpointUrl": "https://example.com/trigger",
      "signatureKey": "abcdefghijklmnopqrstuvwxyz0123456789",
      "payload": {},
      "startDate": "2023-08-30",
      "endDate": "2023-08-30",
      "cron": "* * * * *",
      "appId": "dispatch-fpa",
      "isActive": true,
      "TTL": 1695105095
    }
  ],
  "meta": {
    "hasNextPage": true,
    "nextPage": "os1devs.sandbox.getos1.com/core/api/v1/scheduler/schedules/schedule:dffae181-bd71-4566-96ae-d4e8a4f751a8/executions?page=dffae181-bd71-4566-96ae-d4e8a4f751a8"
  },
  "error": {}
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
Create a schedule
Get a schedule by ID