---
title: "Get a scheduled workflow"
method: GET
path: "/scheduled-workflows/{scheduledWorkflowId}"
tags: ["Scheduled Workflows"]
---

# Get a scheduled workflow

`GET /scheduled-workflows/{scheduledWorkflowId}`

Returns a scheduled workflow by its ID.

## Path parameters

- `scheduledWorkflowId` string, required

## Response `200`

- PublicApiScheduledWorkflowResponse
  - `data` object, required
    - `id` string, required — The resource's ID.
    - `workflowId` string, required — The ID of the Workflow
    - `name` string — Optional display name for the schedule. Defaults to the workflow's name.
    - `startDate` string, date-time, required — When the schedule first becomes active. ISO-8601 UTC. Runs are produced from this date forward.
    - `timeZone` string, required — IANA time zone (e.g. `America/New_York`) used when applying the recurrence.
    - `duePeriod` string — Optional ISO-8601 duration (e.g. `P3D`) added to each scheduled run's start to compute its due date.
    - `nextRunDate` string, date-time — When the next workflow run is scheduled to fire. ISO-8601 UTC.
    - `previousRunDate` string, date-time — When the most recent workflow run was fired. ISO-8601 UTC.
    - `createdDate` string, date-time, required — When the resource was first created. ISO-8601 UTC.
    - `createdBy` object, required — User who created the resource.
      - `id` string, required — The resource's ID.
      - `email` string, required — The user's email address (also their login identifier).
      - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `updatedDate` string, date-time, required — When the resource was last modified. ISO-8601 UTC.
    - `updatedBy` object, required — User who last modified the resource.
      - `id` string, required — The resource's ID.
      - `email` string, required — The user's email address (also their login identifier).
      - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `rules` union[] — Recurrence rules that drive the schedule (Daily/Weekly/Monthly/Yearly).
      - union
        - object
          - `interval` integer, required — Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
          - `frequency` 'Daily', required — How often the workflow runs. The other fields on the rule depend on this value: `Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.
        - object
          - `interval` integer, required — Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
          - `by` 'DayOfMonth' | 'DayOfWeek', required — How a `Monthly` rule recurs: `DayOfMonth` repeats on the same calendar date each month (e.g. the 15th); `DayOfWeek` repeats on the same weekday-of-month pattern (e.g. the second Tuesday).
          - `frequency` 'Monthly', required — How often the workflow runs. The other fields on the rule depend on this value: `Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.
        - object
          - `interval` integer, required — Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
          - `weekDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday', required — Day of the week the workflow runs on. Only used by `Weekly` rules.
          - `frequency` 'Weekly', required — How often the workflow runs. The other fields on the rule depend on this value: `Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.
        - object
          - `interval` integer, required — Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
          - `frequency` 'Yearly', required — How often the workflow runs. The other fields on the rule depend on this value: `Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.
    - `assigneeEmails` string[] — Emails of users automatically assigned to each scheduled run when it's created.
    - `links` object[] — Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
      - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
      - `href` string, required — URL of the linked resource.
      - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
      - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
  - `links` object[] — Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.
    - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
    - `href` string, required — URL of the linked resource.
    - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
    - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.

## Other responses

- `default`

---

[API](https://skmtc.net/process/apis/process-street-public-api.md) · [All operations](https://skmtc.net/process/apis/process-street-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/process/process-street-public-api/revisions/6199a9464227/schema)