List custom fields

Retrieve a list of your account’s custom contact properties.

GET /v1/contacts/customFields

List custom fields

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/contacts/customFields \
  --header 'Authorization: Bearer <token>'

Response

[
  {
    "key": "favoriteColor",
    "label": "Favorite Color",
    "type": "string"
  },
  {
    "key": "plan",
    "label": "Plan",
    "type": "string"
  }
]

This endpoint is now deprecated in favor of List contact properties.

Request

No parameters.

Response

This endpoint will return a list of custom field objects.

If your account has no custom fields, an empty list will be returned.

Custom fields · array

Hide properties

key · string

The property’s name key.

label · string

The human-friendly label for this property.

type · string

The type of property (one of string, number, boolean or date).

Response

[
  {
    "key": "favoriteColor",
    "label": "Favorite Color",
    "type": "string"
  },
  {
    "key": "plan",
    "label": "Plan",
    "type": "string"
  }
]