SpecifyDocs

Get schedule

/v1/schedules/{id}

Signed-in sessionLaunch key product.briefingsOperation schedule_get

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

queueDeliveryListenersobject[]
nextRunAtnumber
versionnumberRequired
createdAtnumberRequired
updatedAtnumberRequired
audioRecipeobject
queueDeliveryobjectRequired
automaticPublicationbooleanRequired
automaticDeliverybooleanRequired
idstringRequired
briefingIdstringRequired
briefingTitlestringRequired
timezonestringRequired
recurrencestringRequired
state"active" | "blocked" | "completed" | "paused"Required
maxCreditsPerRunstringRequired
maxCreditsPerMonthstringRequired
missedRunPolicy"run_latest" | "skip"Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.