Skip to main content
GET
List all known properties for an integration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration_id
string<uuid>
required

Query Parameters

record_type
string
required

Record type to list properties for (e.g., 'person', 'contact')

Required string length: 1 - 255
kind
enum<string>
required

Filter by property kind (builtin or custom)

Available options:
builtin,
custom
search
string | null

Search properties by name (case-insensitive)

Maximum string length: 255

Response

Successful Response

Response model for listing properties.

properties
PropertyReadSchema · object[]
required

List of unique property names found in the integration

reason
enum<string>
required

Reason for the result: 'ok' (properties available), or 'no_properties_found' (the integration exposes no property catalog)

Available options:
ok,
no_properties_found
total_count
integer
required

Total number of unique properties found