Skip to main content
GET
/
v1
/
connections
/
{connectionId}
/
schedules
/
{scheduleId}
Get schema refresh schedule
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "connectionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "schedule": "00 09 * * ? *",
  "timezone": "America/New_York",
  "description": "At 09:00 AM EDT",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z",
  "disabledAt": null
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
connectionId
string<uuid>
required

The unique identifier of the connection

​
scheduleId
string<uuid>
required

The unique identifier of the schema refresh schedule

Response

Successfully retrieved schema refresh schedule

​
scheduleId
string<uuid>

The unique identifier of the schema refresh schedule

​
connectionId
string<uuid>

The unique identifier of the connection this schedule belongs to

​
schedule
string

A 6-field cron expression in AWS EventBridge format defining when the schema refresh should run.

Format: minute hour day-of-month month day-of-week year

​
timezone
string

The IANA timezone identifier for when the schedule should run

​
description
string

A human-readable description of the schedule, automatically generated from the cron expression and timezone

​
createdAt
string<date-time>

The timestamp when the schedule was created

​
updatedAt
string<date-time>

The timestamp when the schedule was last updated

​
disabledAt
string<date-time> | null

The timestamp when the schedule was disabled, or null if active