---
title: "Get all product fields"
method: GET
path: "/productFields"
tags: ["ProductFields"]
---

# Get all product fields

`GET /productFields`

Returns data about all product fields.

## Query parameters

- `start` integer
- `limit` integer

## Response `200`

Get data about all product fields

- object
  - `success` boolean — If the response is successful or not
  - `data` object[] — Array containing data for all product fields
    - `name` string, required — The name of the field
    - `options` object[] — When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
    - `field_type` 'varchar' | 'varchar_auto' | 'text' | 'double' | 'monetary' | 'date' | 'set' | 'enum' | 'user' | 'org' | 'people' | 'phone' | 'time' | 'timerange' | 'daterange' | 'address', required — List of all possible field types
    - `id` integer — The ID of the product field
    - `key` string — The key of the product field
    - `order_nr` integer — The position (index) of the product field in the detail view
    - `add_time` string — The product field creation time. Format: YYYY-MM-DD HH:MM:SS
    - `update_time` string — The product field last update time. Format: YYYY-MM-DD HH:MM:SS
    - `last_updated_by_user_id` integer — The ID of the last user to update the product field
    - `created_by_user_id` integer — The ID of the user who created the product field
    - `active_flag` boolean — Whether or not the product field is currently active
    - `edit_flag` boolean — Whether or not the product field name and metadata is editable
    - `add_visible_flag` boolean — Whether or not the product field is visible in the Add Product Modal
    - `important_flag` boolean — Whether or not the product field is marked as important
    - `bulk_edit_allowed` boolean — Whether or not the product field data can be edited
    - `searchable_flag` boolean — Whether or not the product field is searchable
    - `filtering_allowed` boolean — Whether or not the product field value can be used when filtering searches
    - `sortable_flag` boolean — Whether or not the product field is sortable
    - `mandatory_flag` boolean — Whether or not the product field is mandatory when creating products
  - `additional_data` object — Additional data for the product field, such as pagination

---

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