Skip to main content
GET
/
v1
/
workflows
/
{workflow_id}
from retab import Retab

client = Retab()

workflow = client.workflows.get("workflow_abc123xyz")

print(workflow.name)
print(workflow.is_published)
print(workflow.updated_at)
{
  "id": "workflow_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "is_published": true,
  "published_snapshot_id": "snapshot_123",
  "published_at": "2026-03-12T09:45:00Z",
  "draft_version": "draft_v12",
  "organization_id": "org_123",
  "email_senders_whitelist": [],
  "email_domains_whitelist": ["acme.com"],
  "created_at": "2026-03-10T12:00:00Z",
  "updated_at": "2026-03-12T09:45:00Z"
}
Get a single workflow by ID.
from retab import Retab

client = Retab()

workflow = client.workflows.get("workflow_abc123xyz")

print(workflow.name)
print(workflow.is_published)
print(workflow.updated_at)
{
  "id": "workflow_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "is_published": true,
  "published_snapshot_id": "snapshot_123",
  "published_at": "2026-03-12T09:45:00Z",
  "draft_version": "draft_v12",
  "organization_id": "org_123",
  "email_senders_whitelist": [],
  "email_domains_whitelist": ["acme.com"],
  "created_at": "2026-03-10T12:00:00Z",
  "updated_at": "2026-03-12T09:45:00Z"
}

Authorizations

Api-Key
string
header
required

Path Parameters

workflow_id
string
required

Query Parameters

access_token
string | null

Response

Successful Response

id
string
name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

is_published
boolean
default:false

Whether the workflow has been published

published_snapshot_id
string | null

Reference to workflow_snapshots collection for published version

published_at
string<date-time> | null

When the workflow was last published

draft_version
string | null

Current draft version for live entities

organization_id
string | null

The organization that owns this workflow

email_senders_whitelist
string[]

Whitelisted email addresses allowed to trigger this workflow via email

email_domains_whitelist
string[]

Whitelisted email domains allowed to trigger this workflow via email

created_at
string<date-time>
updated_at
string<date-time>