Skip to content
OpenGTM

Get Workbook

GET
/api/workbooks/{workbook_id}
curl --request GET \
  --url 'http://localhost:8000/api/workbooks/example?page=1&page_size=100' \
  --header 'Authorization: Bearer <token>'

Get workbook with paginated rows. Uses WorkbookRow (v2) or falls back to leads DB.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workbook_id
required
Workbook Id
string

Query Parameters

Section titled “Query Parameters”
page
Page
integer
default: 1 >= 1
page_size
Page Size
integer
default: 100 >= 1 <= 5000

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkbookWithLeadsResponse

Full workbook with paginated rows.

object
page
required
Page
integer
page_size
required
Page Size
integer
rows
required
Rows
Array<object>
WorkbookLeadRow

A row as it appears in a workbook — lead data + enrichment overlay.

Compatible with both v1 (leads DB) and v2 (WorkbookRow).

object
canonical_entity_id
Any of:
string
corroboration_count
Any of:
integer
data
Data
object
key
additional properties
any
enrichments
Enrichments
object
key
additional properties
EnrichmentOverlay

Enrichment data for a single cell (AI/computed columns).

object
error
Any of:
string
provenance
Any of:
Provenance

Per-fact provenance for an enriched cell value (license/freshness).

Recorded only when PROVENANCE_TRACKING_ENABLED; absent on legacy/un-enriched cells (backward-compatible). license is a token from licenses.LICENSE_VOCAB.

object
confidence
Any of:
number
fetched_at
Any of:
string
license
License
string
default: unknown
source
required
Source
string
provider
Any of:
string
status
Status
string
default: pending
value
Value
verify_status
Any of:
string
lead
Lead
object
key
additional properties
any
lead_id
Any of:
integer
position
Any of:
integer
row_id
Any of:
integer
source_fetched_at
Any of:
string format: date-time
source_provider
Any of:
string
source_rank
Any of:
integer
source_record_id
Any of:
string
total_rows
required
Total Rows
integer
workbook
required
WorkbookResponse

Workbook response — returned from API.

object
columns_config
required
Columns Config
Array<object>
object
key
additional properties
any
completed_rows
required
Completed Rows
integer
created_at
Any of:
string format: date-time
description
required
Description
string
filter_criteria
Any of:
object
key
additional properties
any
id
required
Id
string
last_run_at
Any of:
string format: date-time
name
required
Name
string
source_config
Any of:
object
key
additional properties
any
source_type
Source Type
string
default: empty
status
required
Status
string
sync_to_leads
Sync To Leads
boolean
default: true
total_rows
required
Total Rows
integer
updated_at
Any of:
string format: date-time
Example
{
  "rows": [
    {
      "data": {},
      "enrichments": {},
      "lead": {}
    }
  ],
  "workbook": {
    "source_type": "empty",
    "sync_to_leads": true
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}