List Contact Properties

Retrieve a paginated list of all custom contact properties in your workspace.

Use Cases:

• Display available properties in your application UI
• Build dynamic form fields based on properties
• Export property schema for documentation
• Validate data before contact creation/update
• Audit custom property usage

Behavior:

• Returns all custom properties (default properties excluded)
• Properties are returned in creation order
• Uses cursor-based pagination for efficiency
• Includes property type, default values, and metadata
• Maximum 100 properties per request
• Shows whether properties are required or optional

Required Scope: read:contacts (contact properties are part of contacts scope)

Response Includes:

• Property ID and name (internal key)
• Display label for UI
• Data type (STRING, NUMBER, DATE, BOOLEAN)
• Default value (if defined)
• Required flag
• Creation and update timestamps

Property Types:

• STRING: Text data (max 5000 characters)
• NUMBER: Numeric values (integers or decimals)
• DATE: Date/timestamp values (ISO 8601 format)
• BOOLEAN: true/false values

Default Properties (not in response):

• email, firstName, lastName (always available, not listed here)