Custom Fields
Get custom fields
This endpoint enables you to get custom fields for your organization, including their names, descriptions, types, constraints, section associations, and slugs.
get/custom_fields
Query parameters
org_idinteger
Filter by organization ID. Only PROVIDER users can use this filter. If you are not a PROVIDER, this will default to the ID of your organization.
Response
OK
Example response
{
"custom_fields": [
{
"id": 1,
"name": "Is Active",
"description": "Whether the business is currently active",
"type": "BOOLEAN",
"order": 1,
"section_id": null,
"section_name": null,
"slug": "is-active"
},
{
"id": 2,
"name": "Description",
"description": "Business description text",
"type": "TEXT",
"max_len": 500,
"order": 2,
"section_id": 1,
"section_name": "Section 1",
"slug": "description"
},
{
"id": 3,
"name": "Employee Count",
"description": "Number of employees",
"type": "INTEGER",
"min": 0,
"max": 10000,
"order": 3,
"section_id": 1,
"section_name": "Section 1",
"slug": "employee-count"
},
{
"id": 4,
"name": "Rating",
"description": "Business rating score",
"type": "FLOAT",
"min": 0,
"max": 5,
"order": 4,
"section_id": 2,
"section_name": "Section 2",
"slug": "rating"
},
{
"id": 5,
"name": "Category",
"description": "Business category type",
"type": "SINGLE_SELECT",
"possible_values": [
"Premium",
"Standard",
"Basic"
],
"order": 5,
"section_id": 2,
"section_name": "Section 2",
"slug": "category"
},
{
"id": 6,
"name": "Tags",
"description": "Business tags for classification",
"type": "MULTIPLE_SELECT",
"possible_values": [
"Featured",
"New",
"Sale",
"Popular"
],
"max_selected_values": 3,
"order": 6,
"section_id": 3,
"section_name": "Section 3",
"slug": "tags"
},
{
"id": 7,
"name": "Product Images",
"description": "Product image selections",
"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"
],
"max_selected_values": 2,
"order": 7,
"section_id": 3,
"section_name": "Section 3",
"slug": "product-images"
},
{
"id": 8,
"name": "Gallery",
"description": "Image gallery uploader",
"type": "IMAGES_UPLOADER",
"text_fields": [
{
"text_field": "Caption",
"max_length": 100
},
{
"text_field": "Alt Text",
"max_length": 50
}
],
"order": 8,
"section_id": 4,
"section_name": "Section 4",
"slug": "gallery"
}
]
}