> ## 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.

# Preview playtable field condition

> Dry run of an UNSAVED run condition over up to 100 named rows of one tab: which rows the column would run on, decided by the same evaluator a paid run uses (MySQL, never the index). No writes, no charges. run_condition null = no gate, every row runs; an unknown record.<slug> or a bad atom is 422 here instead of at save. Use it before create_playtable_field or update_playtable_field sets config.run_condition, on rows from search_people or search_companies.

Contract:
- MCP tool `preview_playtable_field_condition`, registry package `mcp.playtables/playtable_fields`, mount `playtables.columns`.
- Operation `action`, response envelope `action`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/playtables/openapi.yaml post /api/playtable-fields/preview-condition
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-fields/preview-condition:
    post:
      tags:
        - playtable_fields
      summary: Preview playtable field condition
      description: >-
        Dry run of an UNSAVED run condition over up to 100 named rows of one
        tab: which rows the column would run on, decided by the same evaluator a
        paid run uses (MySQL, never the index). No writes, no charges.
        run_condition null = no gate, every row runs; an unknown record.<slug>
        or a bad atom is 422 here instead of at save. Use it before
        create_playtable_field or update_playtable_field sets
        config.run_condition, on rows from search_people or search_companies.


        Contract:

        - MCP tool `preview_playtable_field_condition`, registry package
        `mcp.playtables/playtable_fields`, mount `playtables.columns`.

        - Operation `action`, response envelope `action`.

        - Flags: read only.
      operationId: preview_playtable_field_condition
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewPlaytableFieldConditionRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewPlaytableFieldConditionResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    PreviewPlaytableFieldConditionRequest:
      type: object
      description: Request body of `preview_playtable_field_condition`.
      properties:
        playtable_sid:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^pt_tb_
          description: Owner playtable sid (pt_tb_…).
        object_type:
          type: string
          enum:
            - people
            - company
          description: >-
            Which rows the gate is about, people or company: the tab the draft
            column belongs to.
        run_condition:
          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: record.<slug> or a built-in object
                    attribute; element-relative inside any.where.
                op:
                  type: object
                  properties:
                    eq:
                      anyOf:
                        - type: string
                        - type: number
                        - type: boolean
                    ne:
                      anyOf:
                        - type: string
                        - type: number
                        - type: boolean
                    in:
                      type: array
                      items:
                        anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                      minItems: 1
                      maxItems: 100
                    nin:
                      type: array
                      items:
                        anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                      minItems: 1
                      maxItems: 100
                    gt:
                      anyOf:
                        - type: number
                        - type: string
                    gte:
                      anyOf:
                        - type: number
                        - type: string
                    lt:
                      anyOf:
                        - type: number
                        - type: string
                    lte:
                      anyOf:
                        - type: number
                        - type: string
                    is_null:
                      type: boolean
                    contains:
                      type: string
                      minLength: 1
                    not_contains:
                      type: string
                      minLength: 1
                    contains_any:
                      type: array
                      items:
                        type: string
                        minLength: 1
                      minItems: 1
                      maxItems: 50
                    not_contains_any:
                      type: array
                      items:
                        type: string
                        minLength: 1
                      minItems: 1
                      maxItems: 50
                    starts_with:
                      type: string
                      minLength: 1
                  additionalProperties: false
              required:
                - field
                - op
              additionalProperties: false
            - {}
          description: >-
            The unsaved gate, the shape config.run_condition takes; null or
            absent = no gate, every row runs. An unknown record.<slug> or a bad
            atom is 422 here, not at save.
        object_sids:
          type: array
          items:
            type: string
            minLength: 18
            maxLength: 18
          minItems: 1
          maxItems: 100
          description: >-
            1..100 distinct row sids of the tab (cr_pp_… or cr_co_…) to try the
            gate on.
      required:
        - playtable_sid
        - object_type
        - object_sids
    PreviewPlaytableFieldConditionResponse:
      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:
            rows:
              type: array
              items:
                type: object
                properties:
                  object_sid:
                    type: string
                  will_run:
                    type: boolean
                required:
                  - object_sid
                  - will_run
              description: One verdict per named row, in the order given.
            will_run_count:
              type: integer
              minimum: 0
            evaluated_count:
              type: integer
              minimum: 0
          required:
            - rows
            - will_run_count
            - evaluated_count
        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.