---
title: "GET /api/v1/document/document-field-categories/"
method: GET
path: "/api/v1/document/document-field-categories/"
tags: ["document", "v1"]
---

# GET /api/v1/document/document-field-categories/

`GET /api/v1/document/document-field-categories/`

DocumentFieldCategory List

## Query parameters

- `jq_filters` object

## Response `200`

- DocumentFieldCategoryList[]
  - `id` integer
  - `document_type` string, nullable, required
  - `document_type_title` string, required
  - `name` string, required
  - `order` integer
  - `fields` DocumentFieldCategoryListFieldsInner[], required
    - `id` string, required
    - `category` integer, nullable
    - `code` string, required — Field codes must be lowercase, should start with a Latin letter, and contain only Latin letters, digits, underscores. Field codes must be unique to every Document Type.
    - `title` string, required
    - `order` integer
  - `fields_number` integer, required
  - `export_key` string, uuid

## Changes

- **2021-09-22** `63116f2e9e3e` — 1 info
  - the response property `items/document_type` became required for the status `200`
- **2021-05-24** `8167164be9cc` — 2 info
  - the response optional property `items/fields/items/id` became not read-only for the status `200`
  - the response property `items/fields/items/id` became required for the status `200`
- **2020-12-11** `0957c4a7ae3d` — 2 breaking, 1 info
  - the response property `items/document_type` became optional for the status `200`
  - the response property `items/fields/items/id` became optional for the status `200`
  - the response required property `items/fields/items/id` became read-only for the status `200`

[Change history](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/document/document-field-categories/get.md)

---

[API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.dev/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/revisions/3429f921b4cb/schema)