> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/companies/suggest openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.playtables' description: >- The data platform and the outreach engine: tables of people and companies, their enrichment columns, cells and runs, the data sources that feed them, sender profiles, the stoplist, the activity feed, the credit ledger, and the multichannel workflows with their per-person journeys and tasks. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.playtables`, 142 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.billing`. - name: data_source_items description: >- Registry package `mcp.playtables/data_source_items`, served on MCP mount `playtables.sources`. - name: data_sources description: >- Registry package `mcp.playtables/data_sources`, served on MCP mount `playtables.sources`. - name: notes description: >- Registry package `mcp.playtables/notes`, served on MCP mount `playtables.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - name: playtable_field_values description: >- Registry package `mcp.playtables/playtable_field_values`, served on MCP mount `playtables.columns`. - name: playtable_fields description: >- Registry package `mcp.playtables/playtable_fields`, served on MCP mount `playtables.columns`. - name: playtable_runs description: >- Registry package `mcp.playtables/playtable_runs`, served on MCP mount `playtables.columns`. - name: playtable_views description: >- Registry package `mcp.playtables/playtable_views`, served on MCP mount `playtables.tables`. - name: playtables description: >- Registry package `mcp.playtables/playtables`, served on MCP mount `playtables.tables`. - name: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - name: workflow_attachments description: >- Registry package `mcp.playtables/workflow_attachments`, served on MCP mount `playtables.workflows`. - name: workflow_records description: >- Registry package `mcp.playtables/workflow_records`, served on MCP mount `playtables.journeys`. - name: workflow_sources description: >- Registry package `mcp.playtables/workflow_sources`, served on MCP mount `playtables.workflows`. - name: workflow_tasks description: >- Registry package `mcp.playtables/workflow_tasks`, served on MCP mount `playtables.journeys`. - name: workflow_versions description: >- Registry package `mcp.playtables/workflow_versions`, served on MCP mount `playtables.workflows`. - name: workflows description: >- Registry package `mcp.playtables/workflows`, served on MCP mount `playtables.workflows`. paths: /api/companies/suggest: post: tags: - companies summary: Suggest company filter values description: >- 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. operationId: suggest_company_filter_values requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SuggestCompanyFilterValuesRequest' responses: '200': description: '`action` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SuggestCompanyFilterValuesResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SuggestCompanyFilterValuesRequest: type: object description: Request body of `suggest_company_filter_values`. properties: field: type: string enum: - tag_sids description: >- Facetable field. tag_sids returns tag sids - resolve labels via tags search. term: type: string maxLength: 64 description: Prefix/infix narrowing; omit for top values. filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cr_co_ description: Company sid (cr_co_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_co_ description: Company sid (cr_co_…). additionalProperties: false description: Prefix-validated cr_co_ sid(s). playtable_sids: type: object properties: in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ nin: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ additionalProperties: false description: >- THE table context - every company tab passes { in: [] }; array-overlap. nin answers the complement, memberless rows included. pipeline_stage_category: type: object properties: eq: type: string enum: - cold - approaching - engaging - positive - nurture - negative - disqualified in: type: array items: type: string enum: - cold - approaching - engaging - positive - nurture - negative - disqualified additionalProperties: false description: >- The account's funnel bucket (one of seven), expanded on the server into the team's company stage sids of those categories: ask by name, never resolve the stages yourself. eq approaching = someone was invited or written to and nobody answered. signals: type: array items: type: object properties: key: type: string enum: - awaiting_reply - opened_not_replied - clicked_not_replied - multi_opened - accepted_not_replied - note_read_not_replied - reacted_not_replied - invited_us - followed_us - lead_messaged_first - unanswered_inbound - draft_pending - escalated_open - task_overdue - went_quiet - reactivated - invite_pending - connection_removed - blocked_us - deleted_message - bounced - bounced_hard - complained - booking_link_sent - objective_reached - viewed_our_profile - visited_our_site - visited_not_replied - visited_key_page - multi_visited - submitted_form - company_visited_our_site - no_people - thin_coverage - nobody_reached - no_engagement - no_reply - exhausted - dormant - dm_missing description: >- A catalog signal name. Thread and person names: awaiting_reply (our message is the last), opened_not_replied and clicked_not_replied (our email opened or its link clicked, no reply), multi_opened (3+ opens), accepted_not_replied (invite accepted, nothing after), note_read_not_replied (the accept delivered our invite note, no reply), reacted_not_replied (an emoji on our message, no reply), invited_us (their invitation to us, unanswered), followed_us, lead_messaged_first (an inbound thread), unanswered_inbound, draft_pending (an AI draft awaits approval), escalated_open (handed to a person, task open), task_overdue, went_quiet (they had replied, then nothing), reactivated (an inbound after 30+ quiet days), invite_pending (our invite out, neither accepted nor withdrawn), connection_removed, blocked_us, deleted_message, bounced, bounced_hard (the address is gone), complained, booking_link_sent, objective_reached (the live dialog landed its goal), viewed_our_profile. Website names: visited_our_site, visited_not_replied, visited_key_page (a page the team marked key), multi_visited, submitted_form, company_visited_our_site (someone from the company, nobody recognized; a person's and a company's). Account names, companies only (dormant also a person's): no_people (nobody to work), thin_coverage (under 3 people to work), nobody_reached, no_engagement (touched, nothing came back), no_reply (touched, no reply), exhausted (everyone nurture or negative), dormant (touched once, quiet since), dm_missing (a Wrong Decision Maker named, no positive person left). Tracking facts are private: never tell the lead (submitted_form excepted). age_days: type: integer minimum: 0 maximum: 3650 description: >- At least this many days on the signal's clock (0 = any). Defaults when omitted: 1 visited_not_replied; 3 awaiting_reply and the *_not_replied names; 14 went_quiet, invite_pending; 30 no_engagement, no_reply; 180 dormant; the rest any age. required: - key minItems: 1 maxItems: 9 description: >- ES-only. Named signals of the account, all must hold: its own visit and the account names rolled up over the people to work (disqualified or stoplisted people do not count). Never compose the roll-ups yourself. A person's or a thread's name is a 422. data_source_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^ds_sc_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ds_sc_ is_null: type: boolean additionalProperties: false description: Import provenance (ds_sc_…). status: type: object properties: eq: type: string enum: - ok - failed_validation - duplicate - stoplisted ne: type: string enum: - ok - failed_validation - duplicate - stoplisted in: type: array items: type: string enum: - ok - failed_validation - duplicate - stoplisted nin: type: array items: type: string enum: - ok - failed_validation - duplicate - stoplisted additionalProperties: false duplicate_of_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cr_co_ description: Company sid (cr_co_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_co_ description: Company sid (cr_co_…). is_null: type: boolean additionalProperties: false description: >- The copies of a primary: { eq: }. is_null:true = rows that are not flagged duplicates. tag_sids: type: object properties: in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_tg_ nin: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_tg_ additionalProperties: false description: >- Array-overlap (any of); cr_tg_ sids - resolve labels via tags. nin answers the complement, untagged rows included. ln_id: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: Exact LinkedIn company id. ln_nickname: type: object properties: eq: type: string is_null: type: boolean additionalProperties: false description: Exact page slug; fuzzy matching goes through q. domain: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: Lowercased apex; is_null = enrichment gap. name: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: Exact match; substring goes through q. q: type: string maxLength: 128 description: >- Free text over name, domain, website, ln_nickname (ES full-text). created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 range; combine bounds in one object. updated_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false deleted_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: 'Default scope is { is_null: true } (live rows).' description: 'Scope (typically { playtable_sids: { in: […] } }).' limit: type: integer minimum: 1 maximum: 50 description: Default 20. required: - field SuggestCompanyFilterValuesResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - action action: type: string description: kebab-case verb; matches the route segment. item: {} result: type: object properties: suggestions: type: array items: type: object properties: value: type: string description: Distinct field value (cr_tg_ sid for tag_sids). count: type: integer minimum: 0 description: Matching rows within the filter scope. required: - value - count required: - suggestions meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - action - item - result - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.