---
title: "Get custom fields"
method: GET
path: "/custom_fields"
tags: ["Custom Fields"]
---

# Get custom fields

`GET /custom_fields`

This endpoint enables you to get custom fields for your organization, including their names, descriptions, types, constraints, section associations, and slugs.

## Query parameters

- `org_id` integer

## Response `200`

OK

- object
  - `custom_fields` CustomFieldTypeGet[]
    - union
      - CustomFieldBoolGet — Boolean Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — BOOLEAN
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldTextGet — Text Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — TEXT
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `max_len` integer — maximum lenght for TEXT field
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldIntegerGet — Integer Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — INTEGER
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `min` integer — minimum value for INTEGER field
        - `max` integer — maximum value for INTEGER field
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldFloatGet — Float Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — FLOAT
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `min` number — minimum value for FLOAT field
        - `max` number — maximum value for FLOAT field
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldSingleSelectGet — Single Select Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — SINGLE_SELECT
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `possible_values` string[] — list of available values
        - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_values. Orders with gaps (e.g., [5, 8, 1]) will be automatically normalized to consecutive values (e.g., [2, 3, 1]) while preserving the relative ordering.
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldMultipleSelectGet — Multiple Select Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — MULTIPLE_SELECT
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `possible_values` string[] — list of available values
        - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_values. Orders with gaps (e.g., [5, 8, 1]) will be automatically normalized to consecutive values (e.g., [2, 3, 1]) while preserving the relative ordering.
        - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldMultipleSelectImageGet — Multiple Select Image Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — MULTIPLE_SELECT_IMAGE
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `possible_values` string[] — List of available values. Each element corresponds to one of possible_images_urls and possible_images_labels. Hence, the 3 lists shall have the same size.
        - `possible_images_urls` string[] — List of available urls
        - `possible_images_labels` string[] — List of available labels. Can be set to null but shall always have the same number of elements as possible_values and possible_images_urls.
        - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_values. Orders with gaps (e.g., [5, 8, 1]) will be automatically normalized to consecutive values (e.g., [2, 3, 1]) while preserving the relative ordering.
        - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.
      - CustomFieldImagesUploaderGet — Images uploader Custom Field
        - `id` integer — Id of the custom field
        - `name` string — The name of the custom field
        - `description` string, nullable — Description of the custom field
        - `type` string — IMAGES_UPLOADER
        - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>`
        - `text_fields` object[] — Configuration for text type Custom Fields
          - `text_field` string, required — Name of the text field
          - `max_length` integer, nullable — Maximum length for the text field
        - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
        - `section_id` integer — Id of the custom field section
        - `section_name` string — The name of the custom field section. Needs to be unique from all other section names.

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action
- `404` — Resource does not exist

---

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