notes
Get configuration
Returns configuration metadata for a specific note type, including supported fields, patch operations, and validation rules.
Use this endpoint to programmatically discover the configuration for a specific note type.
get/notes/configurations/{type}
Path parameters
type'simple' | 'textNote' | 'conversation' | 'conversationNote' | 'opportunity' | 'opportunityNote' required
Example:textNote
The note type to retrieve configuration for. Legacy note type aliases are also accepted.
Response
Configuration details
Example response
{
"data": {
"filters": [
{
"name": "owner[id]",
"field": "owner",
"relationship": "parent",
"requiredScopes": [
"members:pii:read"
]
}
]
}
}