• Search entities Added support for filtering by custom fields in filter.fields. Text, number, date, single-select, and multi-select custom fields are supported with type-specific operators (contains, eq, id/name, any/all)
  • Search entities Changed return.fields to accept "all" or "default" as string values, in addition to an array of field names
  • Create field value Added endpoint to create a new value (option) for a select-type field (SINGLE_SELECT, MULTI_SELECT, TAG). If color is omitted, the next available color is assigned automatically
  • Update field value Added endpoint to update an existing value on a select-type field. Only provided fields are updated; omitted fields remain unchanged
  • Delete field value Added endpoint to delete a value from a select-type field. Use force=true to unset the value from all entities, or replaceWith to reassign assignments to another value (the two parameters are mutually exclusive)
  • Search members Removed deprecated legacy flat properties (ids, emails, roles, includeDisabled, includeInvitationPending, query) from the request body. Use the structured filter, search, and return objects instead
  • Search teams Removed deprecated legacy flat properties (ids, names, handles) from the request body. Use the structured filter and search objects instead
  • Search notes Removed deprecated legacy flat properties (ids, archived, processed, owners, creators, source, metadata, createdAt, updatedAt, relationships, fields) from the request body. Use the structured filter and return objects instead
  • List notes Removed deprecated source[recordId] query parameter. Use metadata[source][recordId] instead
  • Search plugin integration connections Added new POST endpoint to search connections by state and entityId filters in the request body, useful when filtering by many entity IDs or when URL length limits apply
  • List plugin integration connections Added state[] query parameter to filter connections by state
  • Plugin integration responses now include a connections link pointing to the connections list for each integration
  • Public API v2 is now generally available and out of beta. It is the recommended version for all new integrations
  • Public API v1 is now deprecated. Existing integrations should migrate to v2
  • Public API v1 will be sunset on July 8, 2026. After this date, v1 endpoints will no longer be available
  • All v1 responses now include RFC 8594 Deprecation and Sunset headers, plus a Link header with rel="sunset" pointing to the migration guide

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.

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.

v2 - 2026-03-26 - Field values

by ReadMe GitHub Action
  • 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