Contract Intelligence

List a vault's columns

List every column in a vault's table, in the order the table shows them.

The list covers both kinds of column. Built-in columns, such as Document Type and Effective Date, come from GC AI and appear in every vault; they report id: null and kind: built_in, and no endpoint changes them. The rest belong to this vault and carry an ID. Of those, kind: custom columns are yours to change, and kind: system columns (Document Name, Document Status, Document Title) are managed by GC AI and reject every change.

Columns a member has hidden in the app are listed too: hiding is a display preference, and a hidden column still holds its values and still counts toward the vault's 500 column limit.

Requires a user-scoped API key (u:gcai_...). A vault is shared with named people, so an organization-scoped key has no identity to resolve vault access with.

get/vaults/{id}/columns

Request

Path parameters

idstring uuid required

The vault ID

Response

The vault's columns

Example response

{
  "columns": [
    {
      "field_key": "renewalNotice",
      "label": "Renewal notice"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.