List configurations
Returns configuration metadata for note types, including supported fields, patch operations, and validation rules.
Use this endpoint to programmatically discover which fields are available, what note types are supported, and how your workspace is configured.
Filtering by Type
By default, this endpoint returns configurations for all available note types (textNote, conversationNote, opportunityNote).
You can filter results to specific types using the optional type[] query parameter:
- type[]=textNote
- type[]=textNote&type[]=conversationNote
For backward compatibility, the API also accepts a single type query parameter with one value, for example type=textNote.
Legacy aliases (simple, conversation, opportunity) are also accepted and normalized to the canonical values above.
Query parameters
Optional array of note types to filter results. Valid values: textNote, conversationNote, opportunityNote. Legacy aliases simple, conversation, opportunity are also accepted. Example: type[]=textNote&type[]=conversationNote
[ "textNote" ]
Optional single note type filter for backward compatibility. Valid values: textNote, conversationNote, opportunityNote. Legacy aliases simple, conversation, opportunity are also accepted. Example: type=textNote Note: Use type[] to filter by multiple note types.
Response
A list of entity configurations
Example response
{
"data": [
{
"filters": [
{
"name": "owner[id]",
"field": "owner",
"relationship": "parent",
"requiredScopes": [
"members:pii:read"
]
}
]
}
]
}