---
title: "Retrieve a workflow"
method: GET
path: "/api/v1/workflows/{id}"
tags: ["Workflows"]
---

# Retrieve a workflow

`GET /api/v1/workflows/{id}`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/workflows/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `workflows:read`)

The workflow itself — its trigger, re-entry policy and rate cap. The step graph is not part of the v1 contract.

Requires the `workflows:read` scope — View your automation workflows and their runs.

## Path parameters

- `id` string, uuid, required: Workflow id.

## Response `200`

Workflow

- WorkflowV1: An automation workflow as exposed on the v1 API.
  - `allow_reentry` boolean, required
  - `created_at` string, date-time, required
  - `description` string, nullable, required
  - `enabled` boolean, required
  - `event_name` string, nullable, required: Trigger event for `EVENT` workflows; null for the other trigger types.
  - `id` string, uuid, required
  - `max_executions_per_hour` integer, nullable, required
  - `name` string, required
  - `step_count` integer, required: Steps in this workflow's graph, trigger step included — so a workflow that has only ever been created reports 1. Read `/graph` for the steps themselves.
  - `trigger_type` 'EVENT' | 'MANUAL' | 'SCHEDULE', required
  - `updated_at` string, date-time, required
  - `version` integer, required: Incremented on every structural (step/transition) change.

## Other responses

- `401`: `invalid_api_key` or `invalid_session` — missing or invalid credentials.
- `403`: `scope_missing`, `project_access_denied`, or `project_disabled`.
- `404`: `resource_not_found` — no workflow with this id belongs to the authenticated project.
- `422`: `validation_error` — query, path, or body parameters did not match the schema.
- `429`: `rate_limited` — see `Retry-After` and the `RateLimit` headers.
- `500`: `internal_error`.

---

[API](https://skmtc.dev/sendly/apis/sendly-api.md) · [All operations](https://skmtc.dev/sendly/apis/sendly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sendly/apis/sendly-api/revisions/ce7cfb7f7c7e?raw)
