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.published.snapshot_id if workflow.published else None)
print(workflow.updated_at)
{
  "id": "workflow_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "organization_id": "org_123",
  "published": {
    "snapshot_id": "snapshot_123",
    "published_at": "2026-03-12T09:45:00Z"
  },
  "email_trigger": {
    "allowed_senders": [],
    "allowed_domains": ["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.published.snapshot_id if workflow.published else None)
print(workflow.updated_at)
{
  "id": "workflow_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "organization_id": "org_123",
  "published": {
    "snapshot_id": "snapshot_123",
    "published_at": "2026-03-12T09:45:00Z"
  },
  "email_trigger": {
    "allowed_senders": [],
    "allowed_domains": ["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

Public workflow resource returned by workflow metadata endpoints.

id
string
required

Unique ID for this workflow

name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

organization_id
string | null

The organization that owns this workflow

published
WorkflowPublished · object

Published workflow metadata when a published snapshot exists

email_trigger
WorkflowEmailTrigger · object

Email trigger allowlist policy

email_senders_whitelist
string[]

Legacy mirror of allowed sender email addresses.

email_domains_whitelist
string[]

Legacy mirror of allowed sender email domains.

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