---
title: "Search result pages"
method: POST
path: "/api/result-pages/search"
tags: ["result_pages"]
---

# Search result pages

`POST /api/result-pages/search`

## Request

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

List the team's public result pages: chart pictures people put behind a public link from the Share window of the Dashboard or of a table's Overview. Each says whose it is (owner_sid), of which chart (scope, playtable_sid), what it says (headline, description) and where it answers (public_url). For "what have we shared publicly" or to find a page to take down. Metadata only: the picture is at the page's address.

Contract:
- MCP tool `search_result_pages`, registry package `mcp.playtables/result_pages`, mount `playtables.tables`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchResultPagesRequest: Request body of `search_result_pages`.
  - `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: Prefix-validated pt_rp_ sid(s) - also the point-lookup path (no get tool).
      - `eq` string: Result page sid (pt_rp_…).
      - `in` string[]
    - `owner_sid` object: Whose pages: the publisher's actor sid (us_mb_…).
      - `eq` string
      - `in` string[]
    - `scope` object: workspace for the Dashboard's machine, playtable for a table's flow.
      - `eq` 'workspace' | 'playtable'
      - `in` string[]
    - `playtable_sid` object: The table of a table's page (pt_tb_…); { is_null: true } picks the workspace's pages.
      - `eq` string
      - `in` string[]
      - `is_null` boolean
    - `created_at` object: ISO 8601 range over the first publish; combine bounds in one object.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
    - `updated_at` object: ISO 8601 range over the last publish.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
    - `deleted_at` object: Default scope is { is_null: true } (live pages); { is_null: false } lists the ones taken down.
      - `gte` string
      - `lte` string
      - `is_null` boolean
  - `sort` object: One column and its direction; omit for the default order.
    - `field` 'created_at' | 'updated_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.

- SearchResultPagesResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: Result page sid (pt_rp_…); the 12 characters after pt_rp_ are the key, the last segment of public_url.
      - `team_sid` string, required: Owning team (ts_tm_…, external - gs.service.id).
      - `owner_sid` string, required: Who published it (us_mb_ user, id_ak_ API key). One live page per owner and chart: a teammate's page of the same chart is another page.
      - `scope` 'workspace' | 'playtable', required: What the picture is of: workspace = the Dashboard's machine, every table; playtable = one table's flow (playtable_sid).
      - `playtable_sid` string, nullable, required: The table of a playtable page (pt_tb_…); null for a workspace page.
      - `headline` string, required: The picture's headline (1..160): the page's title and og:title.
      - `description` string, required: The line under the headline (1..400), og:description, in the publisher's language.
      - `brand_name` string, required: Who the picture says made it (1..80): GetSales, or a reseller's name on a whitelabel host; og:site_name.
      - `locale` 'en' | 'es' | 'fr' | 'pt' | 'de' | 'hi' | 'zh' | 'ar' | 'ru', required: The language the headline and the description are written in.
      - `version` integer, required: How many different pictures the page has carried; a publish of a new picture at the same address bumps it.
      - `public_url` string, required: The page's public address, stamped at the first publish and never moved. A network is handed public_url?v={version} past version 1.
      - `created_by` object, required: Actor whose publish minted the page (AccessIdentityValue).
        - `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: ISO 8601 UTC - the first publish.
      - `updated_at` string, required: ISO 8601 UTC - the last publish that changed the picture or the words.
      - `deleted_at` string, nullable, required: ISO 8601 UTC; null = live, set = taken down (its address answers 404).
    - `included` object, 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` integer, required: Pages matching the filter (full filter scope, not the page).
    - `groups` union, required: Always empty - no group axis. PHP serialises an empty map as [].
      - 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)