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

client = Retab()

block = client.workflows.blocks.get(
    "extract-1",
)

print(block.type, block.label)
print(block.config)

{
  "id": "extract-1",
  "workflow_id": "wf_abc123xyz",
  "type": "extract",
  "label": "Extract Invoice Fields",
  "position_x": 320,
  "position_y": 0,
  "width": 240,
  "height": 120,
  "config": {
    "model": "gpt-5",
    "json_schema": {
      "type": "object",
      "properties": {
        "invoice_number": { "type": "string" },
        "total": { "type": "number" }
      }
    }
  },
  "parent_id": null,
  "updated_at": "2026-05-01T14:30:00Z"
}
Get a single authored block from the workflow’s current draft. 
from retab import Retab

client = Retab()

block = client.workflows.blocks.get(
    "extract-1",
)

print(block.type, block.label)
print(block.config)

{
  "id": "extract-1",
  "workflow_id": "wf_abc123xyz",
  "type": "extract",
  "label": "Extract Invoice Fields",
  "position_x": 320,
  "position_y": 0,
  "width": 240,
  "height": 120,
  "config": {
    "model": "gpt-5",
    "json_schema": {
      "type": "object",
      "properties": {
        "invoice_number": { "type": "string" },
        "total": { "type": "number" }
      }
    }
  },
  "parent_id": null,
  "updated_at": "2026-05-01T14:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
block_id
string
required

Query Parameters

​
workflow_id
string | null

Disambiguates a block id that is shared by more than one workflow. Required only when the block id is not unique within your organization — otherwise the call returns 409 listing the colliding workflow_ids. Server-generated block IDs are always unique and never need this.

Response

Successful Response

Public live workflow block object.

​
id
string
required
​
workflow_id
string
required

Foreign key to workflow

​
type
enum<string>
required

Block type (extract, parse, classifier, etc.)

Available options:
start_document,
start_json,
note,
parse,
edit,
extract,
split,
classifier,
conditional,
api_call,
function,
while_loop,
for_each,
merge_dicts,
while_loop_sentinel_start,
while_loop_sentinel_end,
for_each_sentinel_start,
for_each_sentinel_end
​
updated_at
string<date-time>
required
​
label
string
default:""

Display label for the block

​
position_x
number
default:0

X position on canvas

​
position_y
number
default:0

Y position on canvas

​
width
number | null

Block width for resizable blocks

​
height
number | null

Block height for resizable blocks

​
config
Config · object

Block-specific configuration

​
parent_id
string | null

ID of parent container (while_loop, for_each)

​
declarative_path
string | null

Canonical declarative block path used to reconcile imported specs.

​
declarative_source_block_id
string | null

Authored declarative block id before import-time id regeneration.

​
resolved_schemas
Resolved Schemas · object

Schemas resolved for this block from the workflow graph.