Skip to main content
GET
Read one database schedule

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
name
string
required

Database schedule name, unique per project environment.

Pattern: ^[a-z][a-z0-9_-]{0,62}$

Query Parameters

environment
enum<string>
default:dev

Application environment to read; dev when omitted.

Available options:
dev,
prod

Response

The database schedule.

cron
string
required
Required string length: 9 - 120
every_seconds
null
required
name
string
required
Pattern: ^[a-z][a-z0-9_-]{0,62}$
environment
enum<string>
required
Available options:
dev,
prod
statements
string[]
required
Maximum array length: 20
timeout_ms
integer
required
Required range: 1000 <= x <= 30000
enabled
boolean
required
next_run_at
string<date-time> | null
required
created_at
string<date-time>
required