---
title: "Business fields configuration for a business"
method: GET
path: "/business/{business_id}/business_fields"
tags: ["Business Fields"]
deprecated: true
---

# Business fields configuration for a business

`GET /business/{business_id}/business_fields`

## Request

- Base URL: `https://api.partoo.co/v2`
- URL: `https://api.partoo.co/v2/business/{business_id}/business_fields`
- Auth: API key in header `x-APIKey`
- TypeScript: <https://skmtc.dev/partoo/apis/partoo-rest-api/docs/business/:business_id/business_fields/get.ts> (a function with typed inputs; its response is checked against the schema)

> **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 gives you the list of all the fields that are available for a given Business.     
It also tells you, for each field, if you have the permission to edit it or not, depending of the permission configured by your ORG_ADMIN and your PROVIDER.

## Path parameters

- `business_id` string, 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.dev/partoo/apis/partoo-rest-api.md) - [All operations](https://skmtc.dev/partoo/apis/partoo-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/partoo/apis/partoo-rest-api/revisions/dcb8190f5a29?raw)