> ## 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. # Search playtable views > List saved views of a playtable - grid lenses and workflow audiences. Scope with filter.playtable_sid + object_type for one tab; q searches names; include workflow_sources to see which views are live audiences; counts.groups.object_type feeds tab badges. Use it to resolve a view name into a pt_vw_ sid. NOT for listing the objects matching a view - execute the stored definition via people/companies search. Contract: - MCP tool `search_playtable_views`, registry package `mcp.playtables/playtable_views`, mount `playtables.tables`. - Operation `search`, response envelope `search`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/playtable-views/search 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/playtable-views/search: post: tags: - playtable_views summary: Search playtable views description: >- List saved views of a playtable - grid lenses and workflow audiences. Scope with filter.playtable_sid + object_type for one tab; q searches names; include workflow_sources to see which views are live audiences; counts.groups.object_type feeds tab badges. Use it to resolve a view name into a pt_vw_ sid. NOT for listing the objects matching a view - execute the stored definition via people/companies search. Contract: - MCP tool `search_playtable_views`, registry package `mcp.playtables/playtable_views`, mount `playtables.tables`. - Operation `search`, response envelope `search`. - Flags: read only. operationId: search_playtable_views requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SearchPlaytableViewsRequest' responses: '200': description: '`search` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SearchPlaytableViewsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SearchPlaytableViewsRequest: type: object description: Request body of `search_playtable_views`. properties: filter: type: object properties: q: type: string maxLength: 128 description: Free-text over view names (MySQL LIKE prefix/infix). sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: View sid(s), pt_vw_ prefix. playtable_sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: Primary scope - views of one table (pt_tb_). object_type: type: object properties: eq: type: string enum: - people - company in: type: array items: type: string enum: - people - company additionalProperties: false description: 'Tab filter: people | company.' name: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: Exact name match; substring goes through q. 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. 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 views).' description: >- Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row. include: type: array items: type: string enum: - playtable - workflow_sources description: Relations to attach to every item; omit for the bare rows. sort: type: object properties: field: type: string enum: - created_at - name description: The column to order by. direction: type: string enum: - asc - desc description: asc or desc; default desc. required: - field description: One column and its direction; omit for the default order. page_size: type: integer minimum: 0 maximum: 500 description: 0..500, default 50; 0 = counts only, 1 = the first row. cursor: type: string nullable: true description: pagination.next_cursor of the previous page. SearchPlaytableViewsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - search items: type: array items: type: object properties: item: type: object properties: sid: type: string description: View sid (pt_vw_…). team_sid: type: string description: Owning team (ts_tm_…, external - gs.service.id). playtable_sid: type: string description: Owner playtable (pt_tb_…). object_type: type: string enum: - people - company description: >- Object tab the view lenses: people | company. Fixed at create. name: type: string description: >- View name; unique per (playtable, object_type) among live rows. columns: type: array items: type: object properties: column_type: type: string enum: - group - field - field_group description: >- 'field' = custom field of the table; 'group' = built-in attribute group of the object. column_value: type: string nullable: true description: >- For 'field': pt_fd_ sid of the custom field. For 'group': built-in attribute-group key of the object_type. null for 'field_group'. column_values: type: array nullable: true items: type: object properties: column_value: type: string width: type: integer is_visible: type: boolean required: - column_value - width - is_visible description: >- 'field_group' only: the band's member fields in grid order. is_collapsed: type: boolean nullable: true description: '''field_group'' only: the band folded to its tag.' column_name: type: string nullable: true description: Header label override; null = catalog / field name. is_pinned: type: boolean description: Pinned to the left edge of the grid. width: type: number description: Column width in px (40..1000). is_visible: type: boolean description: Hidden columns keep their slot and order. required: - column_type - column_value - column_name - is_pinned - width - is_visible description: Ordered left→right; [] = base-attribute catalog fallback. sort: type: array items: type: object properties: field: type: string description: >- Built-in object column ("created_at", "full_name") or "record." custom-field reference. direction: type: string enum: - asc - desc description: '''asc'' | ''desc''.' required: - field - direction description: Applied in array order; max 3 entries. filter: anyOf: - type: object properties: and: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - and additionalProperties: false - type: object properties: or: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - or additionalProperties: false - type: object properties: not: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - not additionalProperties: false - type: object properties: any: type: object properties: path: type: string minLength: 1 description: >- Array-valued path - the only way to reach inside an array. where: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - path - where additionalProperties: false required: - any additionalProperties: false - type: object properties: field: type: string minLength: 1 description: >- Namespaced path: built-in object attribute or "record." of the same tab; element-relative inside any.where. op: type: object properties: eq: anyOf: - type: string - type: number - type: boolean description: >- Scalar equality. eq: null is rejected - use is_null. ne: anyOf: - type: string - type: number - type: boolean description: >- Scalar inequality. ne: null is rejected - use is_null. in: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value in list, 1..100 scalars. nin: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value not in list, 1..100 scalars. gt: anyOf: - type: number - type: string description: >- Greater than; string operand = ISO 8601 datetime. gte: anyOf: - type: number - type: string description: >- >= bound; pair with lte in the SAME op for a range. lt: anyOf: - type: number - type: string description: Less than; string operand = ISO 8601 datetime. lte: anyOf: - type: number - type: string description: >- <= bound; pair with gte in the SAME op for a range. is_null: type: boolean description: >- true = absent-or-null; false = present and non-null. contains: type: string minLength: 1 description: Case-insensitive substring match. not_contains: type: string minLength: 1 description: Negated case-insensitive substring match. contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: >- 1..50 strings; true when ANY is a ci substring. not_contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: >- 1..50 strings; true when NONE is a ci substring. starts_with: type: string minLength: 1 description: Case-insensitive prefix match. additionalProperties: false required: - field - op additionalProperties: false - {} description: Stored filter AST (§4.18-atom tree); null = whole tab. created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: >- The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: >- Internal audit context: the cluster that served the write. trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: Actor that created the view (AccessIdentityValue). deleted_by: type: object nullable: true properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: >- The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: >- Internal audit context: the cluster that served the write. trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: Actor that soft-deleted the view; null while live. created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. deleted_at: type: string nullable: true description: ISO 8601 UTC; null = live (soft delete). required: - sid - team_sid - playtable_sid - object_type - name - columns - sort - filter - created_by - deleted_by - created_at - updated_at - deleted_at included: type: object properties: playtable: type: object additionalProperties: {} description: >- Owner playtable row (PlaytableDomain - entities/playtables.md). Present when requested and found. workflow_sources: type: array items: type: object additionalProperties: {} description: >- Sources consuming this view as an audience (WorkflowSourceDomain - entities/workflow_sources.md); max 20, created_at DESC. required: - item - included pagination: type: object properties: next_cursor: type: string nullable: true has_more: type: boolean total_count: type: integer nullable: true required: - next_cursor - has_more - total_count applied_filters: type: object additionalProperties: {} includes: type: array items: type: string 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 counts: type: object properties: total_count: type: integer minimum: 0 description: Rows matching the filter (full filter scope, not the page). groups: type: object properties: object_type: type: object properties: people: type: integer minimum: 0 company: type: integer minimum: 0 required: - people - company description: >- View distribution across the two object tabs (feeds tab badges). required: - object_type required: - total_count - groups required: - success - operation - items - pagination - applied_filters - includes - 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.