Read workspace column catalog

This page documents the canonical HTTP contract for this endpoint.

The response example shows one representative field and object; the live catalog contains the complete workspace projection, including eligible organization custom fields. The workspace path value is an enum: leads, companies, or tasks. Developer-key scopes are enforced per concrete path: /api/workspaces/leads/column-catalog requires both leads:read and companies:read; companies requires companies:read; tasks requires tasks:read. This path-specific authorization is the effective API eligibility; the registry lists broader operation-level scopes.

Responses compose standard workspace fields, organization-specific CRM fields and, when source_table_id is supplied, source-scoped research fields. Each field includes picker identity/path/type and may include field_semantics and value_schema; resolve shared schema definitions through capability schemas. The response is dynamic for the caller's organization and source table.

Path parameters

workspacerequired
string
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 · optional
string
Optional organization-scoped source table; when omitted, research columns are not included.

Name	Type	Description
source_table_id	string	Optional organization-scoped source table; when omitted, research columns are not included.

Errors

Status	Meaning
400	Unsupported workspace value.
401	Authentication required or authenticated user has no organization context.
403	Developer API key lacks one of the scopes required for the selected workspace.

Example

bash

curl 'https://app.autotouch.ai/api/workspaces/leads/column-catalog' -H "Authorization: Bearer $AUTOTOUCH_API_KEY"

Response example

json

{
  "workspace": "leads",
  "source_table_id": null,
  "source_table": null,
  "objects": [{"object_id": "lead", "object_label": "Lead", "object_icon_key": "lead", "fields_count": 1}],
  "fields": [{
    "id": "standard:lead:first_name",
    "label": "First name",
    "object_id": "lead",
    "object_label": "Lead",
    "object_icon_key": "lead",
    "field_key": "first_name",
    "path": "first_name",
    "relationship_path": ["Lead"],
    "source": "crm_standard",
    "category": "crm_model",
    "origin": "standard",
    "data_type": "text",
    "description": null,
    "options": [],
    "flags": {"is_sortable": true, "is_filterable": true, "is_searchable": true, "is_exportable": true, "is_editable": true},
    "field_semantics": {"version": 1, "fieldClass": "normalized", "sourceKind": "crm_standard", "ownerScope": "lead", "canonicalField": "first_name"},
    "value_schema": {},
    "source_table_id": null,
    "source_table_name": null,
    "position": 1000,
    "search_aliases": ["standard:lead:first_name", "first_name", "First name", "standard", "Lead"],
    "column_id": "standard:lead:first_name",
    "column_ids": ["standard:lead:first_name"],
    "export_fields": ["first_name"]
  }]
}