Contract Intelligence

List a vault's saved views

List the saved views in a vault. A view stores a column layout, a sort, and a set of filters, and it is shared: every member of the vault sees the same views.

Column visibility is stored as a hide list. hidden_field_keys names the columns a view hides, so an empty list means the view shows every column the vault has. A column added to the vault later appears in the view until you hide it.

Views come back in the order the app shows them.

Readable by any caller who can read the vault.

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}/views

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/vaults/:id/views/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

The vault ID

Response

The vault views

Example response

{
  "views": [
    {
      "name": "Renewals this quarter",
      "view_state": {
        "sort": {
          "field": "effectiveDate"
        },
        "filters": [
          {
            "field_key": "governingLaw"
          }
        ]
      }
    }
  ]
}

Changes

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