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

client = Retab()

workflows = client.workflows.list(
    limit=10,
    order="desc",
    sort_by="updated_at",
)

next_page = client.workflows.list(
    after=workflows.list_metadata.after,
    limit=5,
)

print(workflows.list_metadata.after)
print(next_page.data[0].name)

{
  "data": [
    {
      "id": "workflow_def456xyz",
      "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"
    },
    {
      "id": "workflow_abc123xyz",
      "name": "Receipt Classification",
      "description": "",
      "published": null,
      "created_at": "2026-03-09T15:30:00Z",
      "updated_at": "2026-03-11T18:20:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": "workflow_abc123xyz"
  }
}
List workflows with id pagination. Use before or after to page through results. 
from retab import Retab

client = Retab()

workflows = client.workflows.list(
    limit=10,
    order="desc",
    sort_by="updated_at",
)

next_page = client.workflows.list(
    after=workflows.list_metadata.after,
    limit=5,
)

print(workflows.list_metadata.after)
print(next_page.data[0].name)

{
  "data": [
    {
      "id": "workflow_def456xyz",
      "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"
    },
    {
      "id": "workflow_abc123xyz",
      "name": "Receipt Classification",
      "description": "",
      "published": null,
      "created_at": "2026-03-09T15:30:00Z",
      "updated_at": "2026-03-11T18:20:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": "workflow_abc123xyz"
  }
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
before
string | null
​
after
string | null
​
limit
integer
default:10

Items per page

Required range: 1 <= x <= 100
​
order
enum<string>
default:desc
Available options:
asc,
desc
​
sort_by
string
default:updated_at

Response

Successful Response

A page of Workflow resources. data holds the items and list_metadata carries the before/after cursors; pass after to fetch the next page.

​
data
Workflow · object[]
required
​
list_metadata
ListMetadata · object
required

Boundary resource IDs for page navigation.