---
title: "List meta fields (index schema)"
method: GET
path: "/documents/meta-fields-list"
tags: ["Document AI — DMS"]
---

# List meta fields (index schema)

`GET /documents/meta-fields-list`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/meta-fields-list`
- Auth: HTTP bearer

List available document meta fields (workspace index schema). Default MCP compact=true (about small). For values on one document use po_intelligence_meta_fields_get. GET /documents/meta-fields-list.

## Query parameters

- `workspace_id` integer
- `compact` boolean
- `locale` string
- `fields_limit` integer

## Response `200`

Success

- object
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `aliases` object
    - `document_type` string
    - `document_status` string
    - `document_keywords` string
    - `workflow_state` string
    - `name_suggestion` string
    - `summary` string
    - `save_paths` string
    - `quality_score` string
    - `currency` string
    - `total_amount` string
    - `net_amount` string
    - `gross_amount` string
    - `vat_amount` string
    - `document_number` string
    - `document_date` string
    - `due_date` string
    - `sender_name` string
    - `recipient_name` string
    - `locale` string
    - `language` string
  - `custom_fields` object[]
    - `field_key` string
    - `labels` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `display_name` string
    - `field_type` string
    - `section` object
      - `keyname` string
      - `labels` object
        - `de` string
        - `en` string
    - `usage_count` integer
    - `options` string
    - `is_custom` boolean
  - `field_groups` object
    - `doc_edit_properties_tab` unknown[]
      - unknown
    - `doc_edit_datafields_tab` unknown[]
      - unknown
  - `processing_time` string
  - `section_labels` object
    - `_metadata` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_classification` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_dates` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_financial` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_parties` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_workflow` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_security` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_extraction` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_audit` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_content_data` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_vision` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_file` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_system` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `_general` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
  - `standard_fields` object[]
    - `field_key` string
    - `labels` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `display_name` string
    - `field_type` string
    - `section` object
      - `keyname` string
      - `labels` object
        - `de` string
        - `en` string
        - `es` string
        - `fr` string
        - `it` string
        - `ru` string
    - `is_standard` boolean
    - `options` object
      - `options_source` string
  - `status` string
  - `system_fields` object[]
    - `field_key` string
    - `labels` object
      - `de` string
      - `en` string
      - `es` string
      - `fr` string
      - `it` string
      - `ru` string
    - `display_name` string
    - `field_type` string
    - `section` object
      - `keyname` string
      - `labels` object
        - `de` string
        - `en` string
        - `es` string
        - `fr` string
        - `it` string
        - `ru` string
    - `usage_count` integer
    - `options` object
      - `options_source` string
    - `is_system` boolean
  - `total_custom` integer
  - `total_standard` integer
  - `total_system` integer

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)