---
title: "Quote Workbench Unlock"
method: POST
path: "/workbench/tables/{table_id}/unlock-quote"
tags: ["Workbench"]
---

# Quote Workbench Unlock

`POST /workbench/tables/{table_id}/unlock-quote`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/workbench/tables/{table_id}/unlock-quote`
- Auth: HTTP bearer

Price an unlock. CHARGES NOTHING, and unlocks nothing.

Returns the exact locked-row count for the scope, the organisation's live
balance, and the shortfall if there is one. It also returns the
`operation_id` that `unlock-rows` REQUIRES - so this call is not optional
advice, it is step one of the handshake.

Send this exact body to `unlock-rows` afterwards: the quote prices the
scope the unlock will charge for, and a different body is a different
price.

## Path parameters

- `table_id` string, required: Workbench table id (UUID).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- UnlockStagingRowsRequest: Which locked rows to price, or to unlock. The SAME body serves the quote and the unlock. Send identical fields to both: the quote prices exactly the scope the unlock will then charge for. OMITTING `row_ids` MEANS EVERY LOCKED ROW IN THE TABLE. That is the app's "Unlock All", and at one credit per row it is the most expensive thing this body can express. `exclude_row_ids` narrows it back down.
  - `row_ids` integer[], nullable: Rows to act on. OMIT to mean EVERY locked row in the table.
  - `exclude_row_ids` integer[], nullable: Rows to leave locked.
  - `approved_max_credits` integer, nullable: Ceiling the caller approves. The run refuses to exceed it.
  - `quote_expires_at` string, date-time, nullable: Expiry of the quote being approved.
  - `operation_id` string, uuid, nullable: The quote's operation id. REQUIRED by the unlock - it is what ties the charge to a price the caller was shown, and it makes a retried unlock idempotent instead of charging twice.

## Response `200`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, required: One enrichment object, open-shaped. Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)