List schedules

GET/v1/schedules

Signed-in sessionLaunch key product.briefingsOperation schedules_list

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.

Query parameters

state"active" | "blocked" | "completed" | "paused"
cursorstring
expectedAuthorizationVersionstring
limitnumber

Returns

itemsobject[]Required
nextCursornull | stringRequired

Errors

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

GET/v1/schedules

curl "$SPECIFY_API_ORIGIN/v1/schedules" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "items": [
      {
        "version": 1,
        "createdAt": 1,
        "updatedAt": 1,
        "queueDelivery": {
          "consentVersion": 1,
          "enabled": true,
          "listenerPrincipalIds": [
            "<listenerPrincipalId>"
          ]
        },
        "automaticPublication": true,
        "automaticDelivery": true,
        "id": "<id>",
        "briefingId": "<briefingId>",
        "briefingTitle": "<briefingTitle>",
        "timezone": "<timezone>",
        "recurrence": "<recurrence>",
        "state": "active",
        "maxCreditsPerRun": "<maxCreditsPerRun>",
        "maxCreditsPerMonth": "<maxCreditsPerMonth>",
        "missedRunPolicy": "run_latest"
      }
    ],
    "nextCursor": "<nextCursor>"
  }
}

List schedules

Headers

Query parameters

Returns

Errors