---
title: "List Company Columns"
method: GET
path: "/companies/columns"
tags: ["Companies"]
---

# List Company Columns

`GET /companies/columns`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/companies/columns`
- Auth: HTTP bearer

List custom company columns (table columns + global dynamic columns; +list-scoped if list_id given).

## Query parameters

- `list_id` integer, nullable: Optional list ID. When provided, list-specific dynamic columns are included alongside global ones.

## Headers

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

## Response `200`

Successful Response

- ApiResponseListColumn
  - `data` Column[], required
    - `id` integer, nullable
    - `title` string, required
    - `data_type` 'text' | 'int' | 'numeric' | 'boolean': User-selectable dynamic-column data types. Every member must have a physical type in the repos' pg_type_map (contacts/companies CDP repos + enrichment DynamicColumnRepository: int→INTEGER, numeric→NUMERIC, text→TEXT, boolean→BOOLEAN) and belong to the user-owned family in lists/usecases/dynamic_column_write_contract.py — both already list these four. Write paths coerce values per type via shared.infrustructure.db.cdp.dynamic_column_values.coerce_dynamic_value.
    - `name` string, nullable
    - `object_id` string, nullable
    - `source` 'contact' | 'company' | 'custom': Which entity a field in the contact field list belongs to. The ``GET /contacts/columns`` response deliberately combines fields from three provenances into one list (issue #21184): the person record, their employer's company record, and user-created custom columns. Consumers (form-mapping UI, AI-agent field listing, CSV import) need to tell them apart — a company field like ``COMPANY_REVENUE`` describes the employer, not the contact. - ``contact``: a field on the person record (``MashupContact.*``) — the default. - ``company``: a field on the contact's employer (``MashupCompany.*``), surfaced so contacts can be mapped/filtered by company attributes. - ``custom``: a user-created dynamic column (global or list-scoped).
    - `is_global` boolean, required: Automatically computed: True if object_id is None/empty, False otherwise.
    - `label` string, nullable, required: Human-readable display name (CF-09), e.g. ``CONTACT_FIRST_NAME`` -> "First name", ``COMPANY_NAICS`` -> "Company NAICS". Custom columns keep their own title. Additive and read-only: ``name`` / ``title`` stay the storage key, because callers send them back as identifiers.
  - `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/2e7cfa0ca921?raw)