Get all customer properties
Get information about customer properties.
Customer properties are custom data field definitions configured at the project level. They extend the standard customer record with project-specific attributes - for example, loyalty tier preferences, subscription levels, or other business-specific data. This endpoint returns the property definitions; to read or update the values stored on a specific customer account, use GET /customers/{customer_id}/properties.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search record by name or a part of the name.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"customer_properties": [
{
"property_id": "size",
"name": "Size",
"description": "size",
"data_type": "string",
"items": [
{
"id": "8fd73167342d0689c4c015320",
"name": "{\"en\":\"evening\",\"cz\":\"vecer\"}",
"resource_record_id": "67342d3167342d0689c4c00689c4",
"state": 1
}
],
"last_change": "2019-06-20 14:48:09",
"state": 1
}
],
"total_items": 1
}
}