Get a collection of properties
Get information about all property records on a customer account.
Customer properties are custom data fields defined 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. Each property record links a property definition to its value on the customer account.
To update properties in bulk, use POST /customers/{customer_id}/properties/batch. To retrieve the available property definitions, use GET /customer-properties.
Path parameters
The unique ID of the customer.
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.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"property_records": [
{
"property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
"property_id": "docasna_blokace_darce_do",
"property_name": "Property #6",
"last_change": "2023-02-02 00:00:00"
}
],
"total_items": 1
}
}