Customer properties

You can store an unlimited amount of linked customer data for each customer account in the CareCloud platform. Standard data structures are available for common customer data. For project-specific data, it is possible to create user-defined data structures called Customer properties. You can customize the Customer properties based on your needs and populate them with data from various sources. You can also work with account properties across the CareCloud ecosystem via the CareCloud API.

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

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/customer-properties?name=Profession
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMDVkNzM3MTU0ODNjYzY3YjM1MTBkMGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 11:22:53 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "customer_properties": [
      {
        "property_id": "profession",
        "name": "Profession",
        "description": "",
        "data_type": "string",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      }
    ],
    "total_items": 1
  }
}


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

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/customer-properties/profession
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMDVkNzM3MTY3NTU0ODNjYzY3YjM1MkMGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 11:23:20 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "property_id": "profession",
    "name": "Profession",
    "description": "",
    "data_type": "string",
    "items": null,
    "is_required": false,
    "is_unique": false,
    "last_change": null,
    "state": 1
  }
}