curl --request GET \
--url https://api.partoo.co/v2/custom_fields \
--header 'x-APIKey: <api-key>'{
"custom_fields": [
{
"id": 1,
"name": "Is Active",
"type": "BOOLEAN",
"order": 1,
"section_id": null,
"section_name": null
},
{
"id": 2,
"name": "Description",
"type": "TEXT",
"max_len": 500,
"order": 2,
"section_id": 1,
"section_name": "Section 1"
},
{
"id": 3,
"name": "Employee Count",
"type": "INTEGER",
"min": 0,
"max": 10000,
"order": 3,
"section_id": 1,
"section_name": "Section 1"
},
{
"id": 4,
"name": "Rating",
"type": "FLOAT",
"min": 0,
"max": 5,
"order": 4,
"section_id": 2,
"section_name": "Section 2"
},
{
"id": 5,
"name": "Category",
"type": "SINGLE_SELECT",
"possible_values": [
"Premium",
"Standard",
"Basic"
],
"order": 5,
"section_id": 2,
"section_name": "Section 2"
},
{
"id": 6,
"name": "Tags",
"type": "MULTIPLE_SELECT",
"possible_values": [
"Featured",
"New",
"Sale",
"Popular"
],
"order": 6,
"section_id": 3,
"section_name": "Section 3"
},
{
"id": 7,
"name": "Product Images",
"type": "MULTIPLE_SELECT_IMAGE",
"possible_values": [
"image1",
"image2",
"image3"
],
"possible_images_urls": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg",
"https://example.com/img3.jpg"
],
"possible_images_labels": [
"Image 1",
"Image 2",
"Image 3"
],
"order": 7,
"section_id": 3,
"section_name": "Section 3"
},
{
"id": 8,
"name": "Gallery",
"type": "IMAGES_UPLOADER",
"text_fields": [
"Caption",
"Alt Text"
],
"order": 8,
"section_id": 4,
"section_name": "Section 4"
}
]
}This endpoint enables you to get custom fields for your organization.
curl --request GET \
--url https://api.partoo.co/v2/custom_fields \
--header 'x-APIKey: <api-key>'{
"custom_fields": [
{
"id": 1,
"name": "Is Active",
"type": "BOOLEAN",
"order": 1,
"section_id": null,
"section_name": null
},
{
"id": 2,
"name": "Description",
"type": "TEXT",
"max_len": 500,
"order": 2,
"section_id": 1,
"section_name": "Section 1"
},
{
"id": 3,
"name": "Employee Count",
"type": "INTEGER",
"min": 0,
"max": 10000,
"order": 3,
"section_id": 1,
"section_name": "Section 1"
},
{
"id": 4,
"name": "Rating",
"type": "FLOAT",
"min": 0,
"max": 5,
"order": 4,
"section_id": 2,
"section_name": "Section 2"
},
{
"id": 5,
"name": "Category",
"type": "SINGLE_SELECT",
"possible_values": [
"Premium",
"Standard",
"Basic"
],
"order": 5,
"section_id": 2,
"section_name": "Section 2"
},
{
"id": 6,
"name": "Tags",
"type": "MULTIPLE_SELECT",
"possible_values": [
"Featured",
"New",
"Sale",
"Popular"
],
"order": 6,
"section_id": 3,
"section_name": "Section 3"
},
{
"id": 7,
"name": "Product Images",
"type": "MULTIPLE_SELECT_IMAGE",
"possible_values": [
"image1",
"image2",
"image3"
],
"possible_images_urls": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg",
"https://example.com/img3.jpg"
],
"possible_images_labels": [
"Image 1",
"Image 2",
"Image 3"
],
"order": 7,
"section_id": 3,
"section_name": "Section 3"
},
{
"id": 8,
"name": "Gallery",
"type": "IMAGES_UPLOADER",
"text_fields": [
"Caption",
"Alt Text"
],
"order": 8,
"section_id": 4,
"section_name": "Section 4"
}
]
}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.
Organization id
OK
Boolean Custom Field
Show child attributes
Id of the custom field
42
The name of the custom field
1 - 50"Click and collect"
BOOLEAN
1"BOOLEAN"
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.
30
Id of the custom field section
6
The name of the custom field section. Needs to be unique from all other section names.
"Section A"
Was this page helpful?