List note 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 (simple, conversation, opportunity).

You can filter results to specific types using the optional type or type[] query parameters:

Array format (recommended):

  • /v2/notes/configurations?type[]=simple - Returns only simple note configuration
  • /v2/notes/configurations?type[]=simple&type[]=conversation - Returns simple and conversation note configurations

Comma-separated format (legacy):

  • /v2/notes/configurations?type=simple - Returns only simple note configuration
  • /v2/notes/configurations?type=simple,conversation - Returns simple and conversation note configurations

Both formats are supported. The array format (type[]) is recommended for better compatibility with standard query parameter parsing.

Language
Credentials
Header
Click Try It! to start a request and see the response here!