---
title: "View defined custom fields."
method: GET
path: "/v1/Fields"
tags: ["Fields"]
---

# View defined custom fields.

`GET /v1/Fields`

List of applicable custom fields.

## Query parameters

- `category` 'AGENT' | 'ATTACHMENT' | 'CONTACT' | 'CUSTOMER' | 'SERVICE_PRODUCT' | 'INVENTORY' | 'INVENTORY_TYPE' | 'LINE' | 'NOTE' | 'ORDER' | 'PRODUCT' | 'REQUEST_SERVICE' | 'TASK' | 'TICKET', required
- `type_id` integer

## Response `200`

OK

- RevAppModelsFieldResult
  - `Fields` RevAppModelsField[] — Fields associated with requested category and type.
    - `field_id` integer — Primary identifier for this field.
    - `label` string — User-defined identifier representing the field.
    - `description` string — User-defined description of the field.
    - `default_value` string — Default value of the field.
    - `required` string — True/false value for whether the field is required for the authenticated user or not.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string
  - `links` RevAppComponentsLink[]
    - `rel` string
    - `href` string

## Other responses

- `404` — NotFound
- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)