Contact properties

List contact properties

Changed on

Retrieve a list of your account's contact properties.<br>Use the list parameter to query "all" or "custom" properties.

get/v1/contacts/properties

Request

  • Base URL
    https://app.loops.so/api
  • Auth
    HTTP bearer

Query parameters

liststring

all (default) or custom (only custom contact properties)

Response

Successful.

keystring required

The key of the contact property.

labelstring required

The human-friendly label for this property.

type'string' | 'number' | 'boolean' | 'date' required

The type of property.

Example response

[
  {
    "key": "favoriteColor",
    "label": "Favorite color",
    "type": "string"
  }
]

Changes

    • info

      api operation id listContactProperties was added

    • warning

      added the new boolean enum value to the / response property for the response status

    • warning

      added the new date enum value to the / response property for the response status

    • warning

      added the new number enum value to the / response property for the response status

    • warning

      added the new string enum value to the / response property for the response status