---
title: "Search playtable runs"
method: POST
path: "/api/playtable-runs/search"
tags: ["playtable_runs"]
---

# Search playtable runs

`POST /api/playtable-runs/search`

## Request

- Base URL: `https://beta.getsales.io/playtables/v1`
- URL: `https://beta.getsales.io/playtables/v1/api/playtable-runs/search`
- Auth: HTTP bearer and API key in header `Team-SID`

Run history and active bulk operations - filter playtable_sid for one table, type (enrich|export|import|bulk), created_by_actor_sid for "my runs", finished_at:{is_null:true} for active; include progress for derived state + job counters; counts = total/active/groups.type; page_size:0 = counts only. Rows hard-purge 90 days after finishing. NOT for per-cell outcomes (playtable-field-values tools) or spend truth (credit-ledger-entries, filter run_sid).

Contract:
- MCP tool `search_playtable_runs`, registry package `mcp.playtables/playtable_runs`, mount `playtables.columns`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchPlaytableRunsRequest: Request body of `search_playtable_runs`.
  - `filter` object: Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row.
    - `sid` object
      - `eq` string: Playtable run sid (pt_rn_…).
      - `in` string[]
    - `playtable_sid` object: Per-table run history (pt_tb_…).
      - `eq` string: Parent playtable sid (pt_tb_…).
      - `in` string[]
    - `object_type` object: Residual inside scope: people | company.
      - `eq` 'people' | 'company'
    - `type` object: enrich | export | import | bulk.
      - `eq` 'enrich' | 'export' | 'import' | 'bulk'
      - `in` string[]
    - `created_by_actor_sid` object: "My runs" - matches created_by.actor_sid (projected column; user / api_key / agent actor sid).
      - `eq` string
    - `finished_at` object: { is_null: true } = active runs; datetime bounds for finished ones.
      - `gte` string
      - `lte` string
      - `is_null` boolean
    - `created_at` object
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
  - `include` string[]: Relations to attach to every item; omit for the bare rows.
  - `sort` object: One column and its direction; omit for the default order.
    - `field` 'created_at' | 'finished_at', required: The column to order by.
    - `direction` 'asc' | 'desc': asc or desc; default desc.
  - `page_size` integer: 0..500, default 50; 0 = counts only, 1 = the first row.
  - `cursor` string, nullable: pagination.next_cursor of the previous page.

## Response `200`

`search` success envelope.

- SearchPlaytableRunsResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required
      - `team_sid` string, required
      - `playtable_sid` string, required
      - `object_type` 'people' | 'company', required
      - `type` 'enrich' | 'export' | 'import' | 'bulk', required
      - `field_sids` string[], nullable, required
      - `scope` object, nullable, required
        - `object_sids` string[], nullable, required
        - `view_sid` string, nullable, required
        - `filter` union, required: Filter AST: and/or/not/any nodes (depth <= 5, root counts) over {field, op} leaves; op = >=1 of the §4.18 atoms; atoms AND.
          - object
            - `and` object[], required
              - …
          - object
            - `or` object[], required
              - …
          - object
            - `not` object, required: 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.
          - object
            - `any` object, required
              - …
          - object
            - `field` string, required: Namespaced path: record.<slug> or a built-in object attribute; element-relative inside any.where.
            - `op` object, required
              - …
          - unknown
      - `params_snapshot` object, nullable, required
      - `max_budget` number, nullable, required
      - `estimated_cost` number, nullable, required
      - `file_url` string, nullable, required
      - `created_by` object, required
        - `actor_type` 'user' | 'support' | 'api_key' | 'system' | 'agent', required
        - `actor_sid` string, nullable, required
        - `team_sid` string, required
        - `actor_name` string, nullable: The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job.
        - `oauth_client_sid` string, nullable: The acting OAuth client (id_oc_*); null off the OAuth path.
        - `reason` string, nullable: Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise.
        - `permissions` object, required: Internal audit context: the grant set the actor held at write time. Not a contract.
        - `cluster_id` integer, nullable: Internal audit context: the cluster that served the write.
        - `trace_id` string, nullable: Internal audit context: the trace id of the request that wrote the row.
      - `created_at` string, required
      - `finished_at` string, nullable, required
    - `included` object, required
      - `progress` object: 1:1 derived progress (include[]=progress): state (queued|running|finished|cancelled), job counters from the Laravel batch, spent_credits from the ledger.
        - `state` 'waiting' | 'resolving' | 'queued' | 'running' | 'finished' | 'cancelled', required: Derived - precedence: cancelled > finished > running > queued. Terminal: finished, cancelled.
        - `total_jobs` number, required
        - `pending_jobs` number, required
        - `processed_jobs` number, required
        - `failed_jobs` number, required
        - `cancelled_at` string, nullable, required
        - `spent_credits` number, required
  - `pagination` object, required
    - `next_cursor` string, nullable, required
    - `has_more` boolean, required
    - `total_count` integer, nullable, required
  - `applied_filters` object, required
  - `includes` string[], required
  - `meta` object, required
    - `trace_id` string, required: UUID v7; same 128-bit value as the X-Trace-Id header.
    - `span_id` string, required: 16 hex chars, root span of this request.
    - `timestamp` string, required: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
    - `duration_ms` integer, required: Server-side wall clock.
    - `team_sid` string, nullable: 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` string, nullable: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.
  - `counts` object
    - `total_count` number, required
    - `active_count` number, required
    - `groups` object, required
      - `type` union, required
        - object
        - unknown[]
          - unknown

## Other responses

- `4XX`: 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.
- `5XX`: MCP error envelope with `error.code` internal_error or service_unavailable.

---

[API](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-playtables.md) - [All operations](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-playtables/llms.txt) - [OpenAPI document](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-playtables/revisions/aa394506515d?raw)