Deprecated
v2 - 2026-04-07 - Search filter restructuring
about 23 hours ago by ReadMe GitHub Action
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,ownersin favor of nested groups (filter.type,filter.id,filter.fields.*,filter.relationships.*) - Deprecated top-level
fieldsparameter; usereturn.fieldsarray instead - Added
filter.createdAtandfilter.updatedAtwithfrom/todate 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,relationshipsat the top level in favor of nested groups (filter.type,filter.id,filter.fields.*,filter.metadata.*,filter.relationships.*) - Added
filter.metadata.sourceto filter by source system and record ID (e.g.,system: "intercom") - Added
filter.createdAtandfilter.updatedAtwithfrom/todate range filtering - Deprecated top-level
fieldsquery parameter; usereturn.fieldsarray 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,queryat the top level in favor offilter.id,filter.fields.*,search.query, andreturn.* - Added
data.search.queryfor full-text search (case-insensitive partial match on name or email, requiresmembers_pii:readscope) - Added
return.includeDisabledto include disabled members alongside active members in results (defaultfalse). Distinct fromfilter.fields.disabled, which exclusively returns only disabled members - Added
return.includeInvitationPendingto include members with pending invitations alongside accepted members (defaultfalse). Distinct fromfilter.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,handlesat the top level in favor offilter.idandfilter.fields.* - Added
data.search.queryfor 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.