Improved
v2 - 2026-03-24 - Entities API filter configuration and new field value schemas
about 18 hours ago by ReadMe GitHub Action
Improved: Entities API
Configuration-driven filters
Entity configurations now include a filters array that describes which filter parameters are available for each entity type. Each filter entry provides:
- The exact query parameter name to use (e.g.,
owner[id],status[name]) - The field or relationship it applies to
- The expected value schema (type and format)
- Any additional OAuth scopes required
Use List entity configurations to discover available filters before calling List entities or Search entities.
New field value schemas with metadata
Added metadata-enriched variants for additional field types:
HealthUpdateFieldValueWithMetadataProgressFieldValueWithMetadataTimeframeFieldValueWithMetadataWorkProgressFieldValueWithMetadata
These follow the same pattern as existing *WithMetadata schemas, including metadata.source and metadata.isViewableOnly properties.