---
title: "Search stoplist entries"
method: POST
path: "/api/stoplist-entries/search"
tags: ["stoplist_entries"]
---

# Search stoplist entries

`POST /api/stoplist-entries/search`

## Request

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

Read the team do-not-contact registry - entries here block people at import promotion, workflow-source entry and task dispatch, and feed the Messaging send-gate. filter.value.eq answers "is X blocked?" (raw forms fine - normalized before compare); q finds fragments ("acme"); slice by identifier_type / source / data_source_sid; deleted_at.is_null:false audits past un-stoplists; page_size:0 + counts.groups = list composition. NOT for why a person is stoplisted - that state lives on people.

Contract:
- MCP tool `search_stoplist_entries`, registry package `mcp.playtables/stoplist_entries`, mount `playtables.stoplist`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchStoplistEntriesRequest: Request body of `search_stoplist_entries`.
  - `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: Entry sid(s), sl_sl_ prefix.
      - `eq` string: Stoplist entry sid (sl_sl_…).
      - `in` string[]
    - `identifier_type` object: ln_member_id | email | domain | ln_nickname | company_ln_nickname.
      - `eq` 'ln_member_id' | 'email' | 'domain' | 'ln_nickname' | 'company_ln_nickname'
      - `in` string[]
    - `value` object: Exact "is X listed?" check - raw input accepted, normalized before compare.
      - `eq` string
      - `in` string[]
    - `source` object: Write path: manual | csv_import | api | unsubscribe.
      - `eq` 'manual' | 'csv_import' | 'api' | 'unsubscribe' | 'complaint'
      - `in` string[]
    - `data_source_sid` object: Entries a retired csv_stoplist data source promoted before 2026-09-20 (ds_sc_…); is_null:true = every row written since.
      - `eq` string
      - `in` string[]
      - `is_null` boolean
    - `q` string: Free text over normalized values (MySQL LIKE prefix/infix) - "anything with acme in it".
    - `created_at` object: ISO 8601 range; combine bounds in one object.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
    - `deleted_at` object: Default scope is { is_null: true } (live entries); { is_null: false } = un-stoplist audit.
      - `gte` string
      - `lte` string
      - `is_null` boolean
  - `sort` object: One column and its direction; omit for the default order.
    - `field` 'created_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.

- SearchStoplistEntriesResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: Stoplist entry sid (sl_sl_…).
      - `team_sid` string, required: Owning team (ts_tm_…, external - gs.service.id).
      - `identifier_type` 'ln_member_id' | 'email' | 'domain' | 'ln_nickname' | 'company_ln_nickname', required: What kind of identifier this row blocks: ln_member_id | email | domain | ln_nickname | company_ln_nickname.
      - `value` string, required: NORMALIZED identifier: the member id as base-10 digits (698599037), lowercase email, bare hostname (acme.com), or a lowercased vanity slug (janecooper, acme-corp). Raw input is not stored, and a URL or a URN never is.
      - `source` 'manual' | 'csv_import' | 'api' | 'unsubscribe' | 'complaint', required: Write path: manual | csv_import | api | unsubscribe. Stamped by the server; csv_import is the one value a user actor may name on create.
      - `data_source_sid` string, nullable, required: Provenance of a row the retired csv_stoplist data source promoted before 2026-09-20 (ds_sc_…); null on every row written since, the csv_import ones included.
      - `data_source_item_sid` string, nullable, required: Provenance of the staged row that produced such an entry (ds_it_…); null on every row written since.
      - `created_by` object, required: Actor that created the entry (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.
      - `deleted_by` object, nullable, required: Actor that un-stoplisted the entry; null while live.
        - `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.
      - `updated_at` string, required: ISO 8601 UTC; always equals created_at - rows have no update path.
      - `deleted_at` string, nullable, required: ISO 8601 UTC; null = live entry (soft delete).
    - `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: Entries matching the filter (full filter scope, not the page).
    - `groups` object, required
      - `identifier_type` union, required: List composition by identifier kind.
        - object
          - `ln_member_id` integer
          - `email` integer
          - `domain` integer
          - `ln_nickname` integer
          - `company_ln_nickname` integer
        - unknown[]
          - unknown
      - `source` union, required: Where the blocks came from.
        - object
          - `manual` integer
          - `csv_import` integer
          - `api` integer
          - `unsubscribe` integer
        - 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)