v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
Facets

Get a file's content types and attributes

See what content types a file is classified under and what attribute values have been set on it.

A file can be classified under multiple content types (e.g., both legal:contract:nda and compliance:audit-report). Each classification comes with its own set of attribute values, the metadata fields defined in your content-type schema.

Response structure:

Each content type entry includes:

  • path: the content type (e.g., legal:contract:nda)
  • label: human-readable name
  • labels: breadcrumb from root to leaf (["Legal", "Contract", "NDA"])

Each attribute value includes:

  • name / label: identifier and display name
  • value: the current value (shape depends on type)
  • type: the attribute type (text, number, date, boolean, select, multi-select)
  • choices: available options for select / multi-select
  • required: whether the attribute is required by the schema

The response includes can_edit, which indicates whether you have permission to modify this file's classifications and attribute values.

To modify: use POST /api/v3/files/{file_id}/facets to classify, set attribute values, or remove classifications.

To set up content types first: see GET /api/v3/content-types/templates (browse starter templates) and POST /api/v3/content-types (adopt or create).

get/api/v3/files/{file_id}/facets

Path parameters

file_idinteger required

Response

can_editboolean required