List Fields

GET/apiv2/pub/schema/fieldsdocuments_read

Returns every filterable field — document metadata columns and custom field template columns (Grid + GridLink). Use the name value as the path parameter in Get Field Values.

Request

No parameters required.

---

Response

200 OK — Array of field definitions

Field	Type	Description
name	string	Field identifier. Documents.<col> or customfields_grid_<id>.cfield_<id>.
label	string	Human-readable display name.
source	string	"document" or "custom_field".
operators	array	Supported filter operators with name and label.
valueEditorType	string	"text", "number", "date", or "select".
metadata	object	Only for GridLink fields. Contains template_id, field_own_id, etc.

Operator names

=, !=, >, <, >=, <=, contains, beginsWith, endsWith, doesNotContain, null, notNull

---

Errors

Status	Reason
401	Invalid or expired token
403	Token lacks documents_read scope

cURL

curl -i -X GET "https://portal.docwize.com/apiv2/pub/schema/fields" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

---

[
  {
    "name": "Documents.doc_type",
    "label": "Type",
    "source": "document",
    "operators": [
      {"label": "Equals", "name": "="},
      {"label": "Contains", "name": "contains"}
    ],
    "valueEditorType": "text"
  },
  {
    "name": "Documents.date",
    "label": "Document Date",
    "source": "document",
    "operators": [
      {"label": "After", "name": ">"},
      {"label": "Before", "name": "<"}
    ],
    "valueEditorType": "date"
  },
  {
    "name": "customfields_grid_5.cfield_101",
    "label": "Invoice Details - Amount",
    "source": "custom_field",
    "operators": [
      {"label": "Equals", "name": "="},
      {"label": "Greater Than", "name": ">"}
    ],
    "valueEditorType": "number"
  }
]

{"detail": "Invalid or expired token"}