curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z",
"api_only": false
}
]
}Retrieve all custom properties previously created.
curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z",
"api_only": false
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
List of CustomProperty.
Show child attributes
Custom property ID.
"cfi_efnjehRH304"
Custom property name.
"Test custom property"
Custom property unique slug.
"test_custom_property"
Custom property type.
date, boolean, number, text, select Entities on which the custom property is available.
customer, product, plan, quote, subscription If the custom property is of type select this is the list of available values.
Creation date of the custom property.
"2024-01-01T22:00:00Z"
Update date of the custom property.
"2024-01-01T22:00:00Z"
If true the custom property will not be displayed in the interface.
Was this page helpful?