> ## Documentation Index
> Fetch the complete documentation index at: https://docs.retab.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Workflow
> Get a single workflow by ID.
Returns workflow metadata only.
Get a single workflow by ID.
```python Python theme={null}
from retab import Retab
client = Retab()
workflow = client.workflows.get("workflow_abc123xyz")
print(workflow.name)
print(workflow.published.version_id if workflow.published else None)
print(workflow.updated_at)
```
```typescript TypeScript theme={null}
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const workflow = await client.workflows.get("workflow_abc123xyz");
console.log(workflow.name);
console.log(workflow.published?.versionId);
console.log(workflow.updatedAt);
```
```go Go theme={null}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
workflow, err := client.Workflows.Get(ctx, "workflow_abc123xyz")
if err != nil {
log.Fatal(err)
}
fmt.Println(workflow.Name)
if workflow.Published != nil {
fmt.Println(workflow.Published.VersionID)
}
fmt.Println(workflow.UpdatedAt)
}
```
```ruby Ruby theme={null}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
workflow = client.workflows.get(workflow_id: 'workflow_abc123xyz')
puts workflow.name
puts workflow.published ? workflow.published.version_id : nil
puts workflow.updated_at
```
```rust Rust theme={null}
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let workflow = client.workflows().get("workflow_abc123xyz").await?;
println!("{}", workflow.name.as_deref().unwrap_or(""));
if let Some(published) = &workflow.published {
println!("{}", published.version_id.as_deref().unwrap_or(""));
}
println!("{}", workflow.updated_at);
Ok(())
}
```
```php PHP theme={null}
workflows()->get(
workflowId: 'wf_abc123',
);
print_r($result);
```
```csharp C# theme={null}
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Workflows.GetAsync("wf_abc123");
Console.WriteLine(result);
```
```java Java theme={null}
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.workflows().get("wf_abc123");
System.out.println(result);
}
}
```
```curl cURL theme={null}
curl -X 'GET' \
'https://api.retab.com/v1/workflows/workflow_abc123xyz' \
-H 'accept: application/json' \
-H 'Authorization: Bearer '
```
```json 200 theme={null}
{
"id": "workflow_abc123xyz",
"name": "Invoice Processing",
"description": "Extract invoice fields and route for review",
"published": {
"version_id": "ver_8zJfV7T9qK2mP4xN6bR1cD3eF5gH7iJ9",
"published_at": "2026-03-12T09:45:00Z"
},
"created_at": "2026-03-10T12:00:00Z",
"updated_at": "2026-03-12T09:45:00Z"
}
```
```json 404 theme={null}
{
"detail": "Workflow not found"
}
```
## OpenAPI
````yaml GET /v1/workflows/{workflow_id}
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
servers:
- url: https://api.retab.com
security: []
paths:
/v1/workflows/{workflow_id}:
get:
tags:
- Workflows
summary: Get Workflow
description: |-
Get a single workflow by ID.
Returns workflow metadata only.
operationId: get_workflow
parameters:
- in: path
name: workflow_id
required: true
schema:
type: string
title: Workflow Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Workflow'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
Workflow:
properties:
id:
type: string
title: Id
description: Unique ID for this workflow
name:
type: string
title: Name
description: The name of the workflow
default: Untitled Workflow
description:
type: string
title: Description
description: Description of the workflow
default: ''
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: >-
Project that owns this workflow. Null only on legacy rows that
predate the project backfill.
published:
anyOf:
- $ref: '#/components/schemas/WorkflowPublished'
- type: 'null'
description: Published workflow metadata when a published version exists
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
type: object
required:
- created_at
- id
- updated_at
title: Workflow
description: A workflow and its current configuration.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
default: []
type: object
title: HTTPValidationError
WorkflowPublished:
properties:
version_id:
anyOf:
- type: string
- type: 'null'
title: Version Id
description: Published content-addressed workflow version ID
published_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Published At
description: When the workflow was last published
description:
type: string
title: Description
description: >-
Release note attached to the currently published version. Echoes the
`description` body passed to `POST /v1/workflows/{id}/publish` so
the caller can confirm it was stored without a separate fetch.
default: ''
type: object
title: WorkflowPublished
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
default: null
ctx:
type: object
title: Context
default: {}
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
````