Get all the configured property definitions objects from the system
Get all available property definitions
This endpoint retrieves all custom property definitions configured for publishing.
A property definition describes a custom field, such as “Location” or “Accessibility”, those are not natively available in Bloxs but can be added to the data shared with a third-party website.
Integrators call this endpoint to see which custom properties currently exist, for example before deleting or updating one by its apiLabel.
Request Fields
This endpoint takes no request parameters.
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
apiLabel | string | Yes | Unique identifier of the custom property, used to reference it in update and delete operations, and as the key of its value in the properties field on published objects. Assigned by the user when the property is created. |
labelName | string | Yes | Display name of the custom property. |
controlType | integer | No | Input control type of the custom property. Valid values are 0 (TextBox), 1 (NumberBox), 2 (DateBox), 3 (Dropdown), 4 (RichText), 5 (AmountBox), 6 (SquareMeterBox), or 7 (MultiSelectDropdown). |
order | integer | No | Display order of this property among the other custom properties, both in the Bloxs screen and, if used that way, on the connected website. Not related to the display order of dropdown options; see options.order for that. |
options | array of object | No | Configured options for the property. Applicable when controlType is Dropdown or MultiSelectDropdown. Empty for all other control types. |
options.value | string | Yes | Display text of the dropdown or multi-select option. |
options.order | integer | No | Display order of this option within the dropdown or multi-select list. |
OK
The API Key of the property, this is the key used to identify the Object property
The name of the property
The type of the property
When the ControlType is Dropdown, then these are the configured options for the Dropdown