v1
latestOpenAPI 3.0.02026-07-2494288373.8 KBList custom properties per entity type
Returns a paginated list of custom properties for a given entity type. Options are not included in this list; use the detail endpoint to retrieve options.
Path parameters
Entity type to retrieve custom properties for.
Query parameters
Filter items by the label.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.
Filter items by the key.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.
Include archived custom properties.
Default is false
Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601
Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.
Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601
Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.
Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field created_at.
Available fields are created_at, key and label.
Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).
Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.
Response
List of custom properties for entity type
ℹ️ Click to see full payload
Example response
{
"data": [
{
"settings": {
"max": 100,
"currency_code": "EUR"
}
}
],
"pagination": {
"count": 42
}
}