Customer properties

Customer properties are list of available properties for customers resource.

Available methods

All available methods for resource customer properties.

HTTP method Endpoint Description
[badge-blue GET] /customer-properties Get information about all customer properties
[badge-blue GET] /customer-properties/{customer_property_id} Get information about a customer property


Get all customer properties

Get information about customer properties
[badge-blue GET] /customer-properties

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name for the property No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
customer_properties Property[] List of all customer properties
total_items integer Count of all found customer properties


Get a customer property

Get information about a specific customer property
[badge-blue GET] /customer-properties/{customer_property_id}

Path parameters

Parameter name Type Description
customer_property_id string The unique id for the customer property

Response

Status code: 200 OK
Output structure : Property