Skip to main content
GET
/
business
/
{business_id}
/
business_fields
Business fields configuration for a business
curl --request GET \
  --url https://api.partoo.co/v2/business/{business_id}/business_fields \
  --header 'x-APIKey: <api-key>'
[
  {
    "name": "address",
    "fields": [
      {
        "name": "country",
        "enabled": true,
        "enabled_for_subroles": true
      },
      {
        "name": "city",
        "enabled": true,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "description",
    "fields": [
      {
        "name": "categories",
        "enabled": true,
        "enabled_for_subroles": true
      },
      {
        "name": "website_url",
        "enabled": true,
        "enabled_for_subroles": true
      }
    ]
  },
  {
    "name": "hours",
    "fields": [
      {
        "name": "open_hours",
        "enabled": true,
        "enabled_for_subroles": true
      }
    ]
  },
  {
    "name": "photos",
    "fields": [
      {
        "name": "cover",
        "enabled": false,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "contact",
    "fields": [
      {
        "name": "phone_number",
        "enabled": true,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "custom_fields",
    "fields": [
      {
        "name": "has_parking",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "BOOLEAN",
        "id": 1,
        "order": 10,
        "section_id": 4
      },
      {
        "name": "special_description",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "TEXT",
        "id": 2,
        "order": 11,
        "max_len": 250,
        "section_id": 6
      },
      {
        "name": "facilities",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "MULTIPLE_SELECT",
        "id": 3,
        "order": 2,
        "possible_values": [
          "handicapped access",
          "toilets",
          "break room"
        ]
      },
      {
        "name": "banner image",
        "enabled": true,
        "enabled_for_subroles": true,
        "id": 4,
        "type": "MULTIPLE_SELECT_IMAGE",
        "order": 10,
        "possible_values": [
          "image 1",
          "image 2",
          "image 3"
        ],
        "possible_images_labels": [
          "label image 1",
          "label image 2",
          "label image 3"
        ],
        "possible_images_urls": [
          "url_of_image_1",
          "url_of_image_2",
          "url_of_image_3"
        ]
      },
      {
        "name": "team members",
        "enabled": true,
        "enabled_for_subroles": true,
        "id": 5,
        "type": "IMAGES_UPLOADER",
        "order": 11,
        "text_fields": [
          {
            "text_field": "text 1",
            "max_length": 10
          },
          {
            "text_field": "text 2",
            "max_length": 20
          },
          {
            "text_field": "text 3",
            "max_length": 30
          }
        ]
      }
    ]
  }
]

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
business_id
string
required

Business id.

It may be replaced by c-{code} where code is the store code, which should be unique per organization. This can be used only for ORG_ADMIN, GROUP_MANAGER and BUSINESS_MANAGER users.

Response

OK

Business Fields sections permissions 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
object[]
Example:
[
  {
    "name": "address",
    "fields": [
      {
        "name": "country",
        "enabled": true,
        "enabled_for_subroles": true
      },
      {
        "name": "city",
        "enabled": true,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "description",
    "fields": [
      {
        "name": "categories",
        "enabled": true,
        "enabled_for_subroles": true
      },
      {
        "name": "website_url",
        "enabled": true,
        "enabled_for_subroles": true
      }
    ]
  },
  {
    "name": "hours",
    "fields": [
      {
        "name": "open_hours",
        "enabled": true,
        "enabled_for_subroles": true
      }
    ]
  },
  {
    "name": "photos",
    "fields": [
      {
        "name": "cover",
        "enabled": false,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "contact",
    "fields": [
      {
        "name": "phone_number",
        "enabled": true,
        "enabled_for_subroles": false
      }
    ]
  },
  {
    "name": "custom_fields",
    "fields": [
      {
        "name": "has_parking",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "BOOLEAN",
        "id": 1,
        "order": 10,
        "section_id": 4
      },
      {
        "name": "special_description",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "TEXT",
        "id": 2,
        "order": 11,
        "max_len": 250,
        "section_id": 6
      },
      {
        "name": "facilities",
        "enabled": true,
        "enabled_for_subroles": true,
        "type": "MULTIPLE_SELECT",
        "id": 3,
        "order": 2,
        "possible_values": [
          "handicapped access",
          "toilets",
          "break room"
        ]
      },
      {
        "name": "banner image",
        "enabled": true,
        "enabled_for_subroles": true,
        "id": 4,
        "type": "MULTIPLE_SELECT_IMAGE",
        "order": 10,
        "possible_values": ["image 1", "image 2", "image 3"],
        "possible_images_labels": [
          "label image 1",
          "label image 2",
          "label image 3"
        ],
        "possible_images_urls": [
          "url_of_image_1",
          "url_of_image_2",
          "url_of_image_3"
        ]
      },
      {
        "name": "team members",
        "enabled": true,
        "enabled_for_subroles": true,
        "id": 5,
        "type": "IMAGES_UPLOADER",
        "order": 11,
        "text_fields": [
          { "text_field": "text 1", "max_length": 10 },
          { "text_field": "text 2", "max_length": 20 },
          { "text_field": "text 3", "max_length": 30 }
        ]
      }
    ]
  }
]