Contacts

Get contact properties

The contacts have their properties. In Tidio there are some default properties like name, email, phone etc. and any other properties that can be defined.

Each property has a specific type, such as text, email, number, phone, or url. With this method, you can retrieve the complete list of the properties defined in the Tidio panel.

get/contact-properties

Request

  • Base URL
    https://api.tidio.com
  • URL
    https://api.tidio.com/contact-properties
  • Auth
    API key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret

Query parameters

cursorstring
Example:aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==

Value from the previous page. Use null to fetch the first one

Response

List of all contact property definitions

Example response

{
  "properties": [
    {
      "name": "contact_property_name",
      "label": "Contact property name",
      "type": "text"
    }
  ],
  "meta": {
    "cursor": "aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==",
    "limit": 1000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.