Search endpoints across entities, notes, members, and teams have been restructured with a new filter format.

Entities

Search entities deprecated flat filter properties in favor of a structured filter object.

• Deprecated type, types, ids, name, archived, parent, statuses, owners in favor of nested groups (filter.type, filter.id, filter.fields.*, filter.relationships.*)
• Deprecated top-level fields parameter; use return.fields array instead
• Added filter.createdAt and filter.updatedAt with from/to date range filtering

Notes

Search notes deprecated flat filter properties in favor of a structured filter object.

• Deprecated ids, archived, processed, owners, creators, source, metadata, createdAt, updatedAt, relationships at the top level in favor of nested groups (filter.type, filter.id, filter.fields.*, filter.metadata.*, filter.relationships.*)
• Added filter.metadata.source to filter by source system and record ID (e.g., system: "intercom")
• Added filter.createdAt and filter.updatedAt with from/to date range filtering
• Deprecated top-level fields query parameter; use return.fields array in the request body instead

Members

Search members deprecated flat filter properties in favor of a structured filter object.

• Deprecated ids, emails, roles, includeDisabled, includeInvitationPending, query at the top level in favor of filter.id, filter.fields.*, search.query, and return.*
• Added data.search.query for full-text search (case-insensitive partial match on name or email, requires members_pii:read scope)
• Added return.includeDisabled to include disabled members alongside active members in results (default false). Distinct from filter.fields.disabled, which exclusively returns only disabled members
• Added return.includeInvitationPending to include members with pending invitations alongside accepted members (default false). Distinct from filter.fields.invitationPending, which exclusively returns only pending members

Teams

Search teams deprecated flat filter properties in favor of a structured filter object.

• Deprecated ids, names, handles at the top level in favor of filter.id and filter.fields.*
• Added data.search.query for full-text search (case-insensitive partial match on team name or handle)

The legacy flat format continues to work but will be removed in a future version.

Breaking change: Simplified query parameter names on Jira integration connections endpoint

The List Jira integration connections endpoint previously used bracket-prefixed query parameters connection[issueKey] and connection[issueId] to filter connections by Jira issue. The connection prefix was redundant since the endpoint already operates on the /connections resource.

What changed:

• connection[issueKey] → issueKey
• connection[issueId] → issueId

If your integration uses these query parameters to filter Jira connections by issue key or ID, update your requests to use the new parameter names.

• List Jira integration connections, Retrieve Jira integration connection Renamed resource type identifier from connection to jiraIntegrationConnection to follow the fully qualified naming convention

Renamed the featureId path parameter to entityId on plugin integration connection endpoints to align with the unified entity model used across the v2 API. This is a non-breaking change — the actual URL pattern is unchanged, only the parameter name in the spec was updated.

• Get plugin integration connection {featureId} → {entityId}
• Configure plugin integration connection {featureId} → {entityId}
• Delete plugin integration connection {featureId} → {entityId}

• Create note, Update note, Retrieve note Renamed note types to new canonical values: textNote, conversationNote, opportunityNote
• Legacy type values (simple, conversation, opportunity) are temporarily supported as aliases and will be removed on April 8, 2026

• List field values Added new endpoint to retrieve paginated list of allowed values for select-type and status fields (single select, multi select, status), with optional assignedEntityType filter for status fields
• Entity configuration endpoints now expose field values for single select, multi select, tags, and status fields

• Update team Team member management moved from dedicated endpoints to patch operations (addItems, removeItems, set, clear) on the update endpoint
• List team members Added new GET /teams/{id}/members endpoint returning a paginated list of team members
• Retrieve member, List members, Search members Added teams field to the member response

Example: Adding a member to a team

PATCH /v2/teams/{team_id}

{
  "data": {
    "patch": [
      {
        "op": "addItems",
        "path": "members",
        "value": [
          { "id": "550e8400-e29b-41d4-a716-446655440001" }
        ]
      }
    ]
  }
}

• Create note Added metadata.source property to specify the external system origin (system, recordId, url) when creating a note
• Retrieve note Notes now include metadata.source in responses
• List notes Added metadata[source][system] and metadata[source][recordId] query parameters for filtering by metadata source
• Search notes Added metadata.source.system and metadata.source.recordId search filters
• Deprecated the source field (id, origin, recordId, url) in favor of the new unified metadata.source system. The old source field will continue to work but should be migrated to metadata.source
• Update entity Field value metadata source properties renamed from externalSystemName/externalRecordId to source.system/source.recordId, and added source.url for linking to the external record
• Retrieve entity, List entities, Search entities Entity field value metadata now uses the unified source.system, source.recordId, and source.url properties in responses

• Search teams Added new endpoint to batch search teams by IDs, names, or handles (up to 100 each)
• Search members Added new endpoint to batch search members by IDs or emails, with filters for roles, disabled status, invitation status, and text query
• List teams Added handle query parameter for case-insensitive exact match filtering
• List teams The query parameter now also matches on team handle

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:

• HealthUpdateFieldValueWithMetadata
• ProgressFieldValueWithMetadata
• TimeframeFieldValueWithMetadata
• WorkProgressFieldValueWithMetadata

These follow the same pattern as existing *WithMetadata schemas, including metadata.source and metadata.isViewableOnly properties.