Contact Properties
GET
Get Contact Property
GET /v1/contact-properties/{contactPropertyId}Retrieve a specific custom contact property by ID.
Use Cases:
- Fetch property metadata for validation
- Display property configuration in UI
- Verify property type before data operations
- Check default values for forms
- Audit property definitions
Behavior:
- Returns complete property definition
- Includes type, default value, and validation rules
- Shows whether property is required
- Property must belong to your workspace
- Includes creation and update timestamps
Required Scope: read:contacts
Response Includes:
- Property identification (id, name)
- Display label for UI
- Data type (STRING, NUMBER, DATE, BOOLEAN)
- Default value (if defined)
- Required flag
- Usage count (number of contacts with this property set)
- Timestamps (createdAt, updatedAt)
Path parameters
contactPropertyIdstringrequiredContact Property ID
Response
200Successfully retrieved contact property with full definition and metadata
objectstringrequiredidstringrequirednamestringrequiredtype"DATE" | "NUMBER" | "STRING"requireddefaultValueanyrequired