ChatGPT ↗
Claude ↗This page documents the canonical HTTP contract for this endpoint.
Developer-key scope is enforced by the concrete workspace path, with the same mapping as the column catalog: Leads requires leads:read and companies:read, Companies requires companies:read, and Tasks requires tasks:read. These differ from the registry's broader operation-level declarations.
The response example is one representative field from a larger, workspace-specific catalog. Without option_field, the response contains workspace-specific fields, descriptor grammar, dynamic prefixes, and preflight endpoints. When option_field is set, the handler returns only options and options_page from the authenticated organization's records; supported geography fields vary by workspace (Lead/Company and Task-relative fields). Use the catalog field's dynamic_options metadata to discover option-backed fields.
Path parameters
workspacerequiredstring
leads, companies, or tasks. Each enum value has a different developer-key scope.
| Name | Type | Description |
|---|---|---|
| workspacerequired | string | leads, companies, or tasks. Each enum value has a different developer-key scope. |
Query parameters
source_table_id· optionalstring
Optional source table for research-backed selection fields.
option_field· optionalstring
When set, return one tenant-scoped geography option page instead of the full selection catalog.
option_query· optionalstring
Literal case-insensitive search within option value/country/state.
option_offset· optionalinteger
Option page offset, minimum 0; default 0.
option_limit· optionalinteger
Option page size, 1–100; default 20.
| Name | Type | Description |
|---|---|---|
| source_table_id | string | Optional source table for research-backed selection fields. |
| option_field | string | When set, return one tenant-scoped geography option page instead of the full selection catalog. |
| option_query | string | Literal case-insensitive search within option value/country/state. |
| option_offset | integer | Option page offset, minimum 0; default 0. |
| option_limit | integer | Option page size, 1–100; default 20. |
Errors
| Status | Meaning |
|---|---|
| 400 | Unsupported workspace or option field. |
| 422 | Invalid option_offset or option_limit bounds. |
| 401 | Authentication required or authenticated user has no organization context. |
| 403 | Developer API key lacks one of the scopes required for the selected workspace. |
| 503 | Organization-specific geography option query timed out. |