v4

latestSwagger 2.02026-08-0343714211.7 MB

metadata_categories

Metadata Categories

List Metadata Categories by Path

get/metadata_categories/list_by_path/{path}

Path parameters

pathstring required

Path to operate on.

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of MetadataCategories objects.

idinteger

Metadata Category ID

namestring

Name of the metadata category.

definitionsobject

Map of key names to arrays of allowed values. An empty array means free-form text.

default_columnsstring[]

Metadata keys that should appear as columns in the UI by default.

Example response

[
  {
    "id": 1,
    "name": "Approval Workflow",
    "definitions": {
      "Approval Status": [
        "Under Review",
        "Approved",
        "Rejected"
      ],
      "Reviewer": []
    },
    "default_columns": [
      "Approval Status"
    ]
  }
]