Business fields configuration for an organization
⚠️ DEPRECATED This endpoint is deprecated in favor of the new Custom Roles system; for migration information, see the Custom Roles & Permissions guide.
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.
Authorizations
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
Unique ID of the organization to which the resource belongs. Only PROVIDER users can access resources from a different organization than their own. If you are not a PROVIDER, this will default to the ID of your organization.
Response
OK
[
{
"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 }
]
}
]
}
]