---
title: "Business fields configuration for an organization"
method: GET
path: "/org/{org_id}/business_fields"
tags: ["Business Fields"]
deprecated: true
---

# Business fields configuration for an organization

`GET /org/{org_id}/business_fields`

> **Deprecated.**

**⚠️ DEPRECATED** This endpoint is deprecated in favor of the new Custom Roles system; for migration information, see the [Custom Roles & Permissions guide](/guides/api/guides/custom-roles-and-permissions).
This endpoint provides the list of all fields available for a given organization.
For each field, it also indicates: - Whether you have permission to edit it, depending on the permissions configured by the `PROVIDER`. - Whether you have granted permission to edit it for `BUSINESS_MANAGER` and `GROUP_MANAGER` roles who have access to the organization's businesses.
Only users with the `ORG_ADMIN` or `PROVIDER` roles can access this information.

## Path parameters

- `org_id` integer, required

## Response `200`

OK

- union[] — Business Fields sections array
  - union
    - BusinessFieldsSectionNormal — Business Fields Section
      - `name` string — Name of a the section. The structure of the fields inside it depends of the section and is described below.
      - `fields` BusinessFieldsField[]
        - `name` string — Name of the field
        - `enabled` boolean — Permission (enabled | disabled) of the field for the current user
        - `enabled_for_subroles` boolean — Permission (enabled | disabled) of the field for the users with a more restrictive role compared to the current user. E.g., if the user is ORG_ADMIN: enabled_for_subroles describes the permissions of the field for all the GROUP_MANAGER and BUSINESS_MANAGER of the given organization. E.g., if the user is PROVIDER: enabled_for_subroles describes the permissions of the field for all the ORG_ADMIN, GROUP_MANAGER, and BUSINESS_MANAGER of the given provider.
    - BusinessFieldsSectionCustomFields — Business Fields Section of Custom Fields
      - `name` string — Name of a the section. The structure of the fields inside it depends of the section and is described below.
      - `fields` CustomFieldsMetadata[]
        - `name` string — Name of the field
        - `enabled` boolean — Permission (enabled | disabled) of the field for the current user
        - `enabled_for_subroles` boolean — Permission (enabled | disabled) of the field for the users with a more restrictive role compared to the current user. E.g., if the user is ORG_ADMIN: enabled_for_subroles describes the permissions of the field for all the GROUP_MANAGER and BUSINESS_MANAGER of the given organization. E.g., if the user is PROVIDER: enabled_for_subroles describes the permissions of the field for all the ORG_ADMIN, GROUP_MANAGER, and BUSINESS_MANAGER of the given provider.
        - `type` 'TEXT' | 'INTEGER' | 'FLOAT' | 'BOOLEAN' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MULTIPLE_SELECT_IMAGE' | 'IMAGES_UPLOADER' — Type of the custom field. Possible values are "TEXT", "INTEGER", "FLOAT", "BOOLEAN", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
        - `id` integer — ID of the custom field.
        - `order` integer

## 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)
