Get Field Values
GET/apiv2/pub/schema/values/{field_name}documents_read
Returns distinct values for any field — document columns, Grid custom fields, or GridLink custom fields. Only values from documents accessible to the token's user are returned.
Request
Path parameters
| Parameter | Type | Description |
|---|---|---|
field_name | string | Field identifier from List Fields (e.g. Documents.doc_type or customfields_grid_5.cfield_101). |
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | — | Filter values by substring match. |
limit | integer | 100 | Max values to return (1–500). |
Response
200 OK — Flat array of distinct string values, sorted ascending.
Errors
| Status | Reason |
|---|---|
| 400 | Unknown field name format |
| 401 | Invalid or expired token |
| 404 | Custom field template or column not found |
cURL
curl -i -X GET "https://portal.docwize.com/apiv2/pub/schema/values/Documents.doc_type" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
# Custom field values with search
curl -i -X GET "https://portal.docwize.com/apiv2/pub/schema/values/customfields_grid_5.cfield_101?search=INV&limit=20" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
[
"Contract",
"Invoice",
"Memo",
"Report"
]