GEgetsales
companies

Suggest company filter values

Facet helper for building filters - distinct values + row counts for ONE field within a filter scope (ES aggregation). Only field: tag_sids - returns tag sids with counts; resolve labels via tags search. term narrows values by prefix/infix. Firmographic facets (industry, specialities, employee ranges, HQ, …) are playtable field values - facet over cells, not here; free-text name/domain typeahead = q on search_companies.

Contract:

  • MCP tool suggest_company_filter_values, registry package mcp.playtables/companies, mount playtables.people.
  • Operation action, response envelope action.
  • Flags: read only.
post/api/companies/suggest

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

field'tag_sids' required

Facetable field. tag_sids returns tag sids - resolve labels via tags search.

termstring

Prefix/infix narrowing; omit for top values.

limitinteger

Default 20.

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

itemunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.