> ## 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 workflow records > People-in-workflow rows. Progress board: filter workflow_sid + status; counts.groups.current_step_id = board columns. Person card: filter people_sid ("which workflows is X in"). Staleness sweep: last_touch_at.lte + sort last_touch_at asc; for failed rows read error_code/error_message. include people hydrates names; workflow_tasks_counts = per-record execution shape. No q - resolve names via people search first. page_size:0 = funnel counts only. Adding people = workflow-sources. Contract: - MCP tool `search_workflow_records`, registry package `mcp.playtables/workflow_records`, mount `playtables.journeys`. - Operation `search`, response envelope `search`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/workflow-records/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/workflow-records/search: post: tags: - workflow_records summary: Search workflow records description: >- People-in-workflow rows. Progress board: filter workflow_sid + status; counts.groups.current_step_id = board columns. Person card: filter people_sid ("which workflows is X in"). Staleness sweep: last_touch_at.lte + sort last_touch_at asc; for failed rows read error_code/error_message. include people hydrates names; workflow_tasks_counts = per-record execution shape. No q - resolve names via people search first. page_size:0 = funnel counts only. Adding people = workflow-sources. Contract: - MCP tool `search_workflow_records`, registry package `mcp.playtables/workflow_records`, mount `playtables.journeys`. - Operation `search`, response envelope `search`. - Flags: read only. operationId: search_workflow_records requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SearchWorkflowRecordsRequest' responses: '200': description: '`search` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SearchWorkflowRecordsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SearchWorkflowRecordsRequest: type: object description: Request body of `search_workflow_records`. properties: filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_rc_ description: Workflow record sid (wf_rc_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_rc_ description: Workflow record sid (wf_rc_…). additionalProperties: false description: >- Prefix-validated wf_rc_ sid(s); also the single-row read (no get tool). workflow_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_wf_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_wf_ additionalProperties: false description: Progress-board scope (wf_wf_…). workflow_version_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_vr_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_vr_ additionalProperties: false description: '"Who is still on the old version" (wf_vr_…).' people_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ additionalProperties: false description: >- Person card (cr_pp_…); bulk ops take sids from people search first. entered_via_source_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_sr_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_sr_ additionalProperties: false description: Per-source cohort (wf_sr_…). sender_profile_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ is_null: type: boolean additionalProperties: false description: >- Per-sender load (ub_sp_…); is_null:true = unpinned (no send steps). current_step_id: type: object properties: eq: type: integer in: type: array items: type: integer additionalProperties: false description: >- Step column of the board (int step id); meaningful only with a workflow_sid filter. status: type: object properties: eq: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited ne: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited in: type: array items: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited nin: type: array items: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited additionalProperties: false last_touch_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: Staleness - "no movement since …"; ISO 8601 bounds. finished_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- { is_null: true } = live records; datetime bounds = terminal cohort. created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: Enrollment window; ISO 8601 bounds, combine 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 rows); set only by parent cascades. 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: - people - workflow - sender_profile - workflow_tasks_counts description: Relations to attach to every item; omit for the bare rows. sort: type: object properties: field: type: string enum: - created_at - last_touch_at - finished_at 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. SearchWorkflowRecordsResponse: 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 team_sid: type: string workflow_sid: type: string description: >- wf_wf_… owning workflow; DB-UNIQUE together with people_sid - one row per (workflow, person) pair, forever - see ./workflows.md. workflow_version_sid: type: string description: >- wf_vr_… version pinned at enrollment - the record executes that step graph even after newer publishes - see ./workflow_versions.md. people_sid: type: string description: >- cr_pp_… the enrolled person; second half of the DB-UNIQUE pair - see ./people.md. entered_via_source_sid: type: string description: >- wf_sr_… entry point that produced the row (immutable audit) - see ./workflow_sources.md. sender_profile_sid: type: string nullable: true description: >- ub_sp_… sender pinned at enrollment; null when the version has no send steps; re-resolved at next dispatch if the profile is deleted - see ./sender_profiles.md. current_step_id: type: number description: >- Small int step id inside the pinned version steps JSON (server-assigned, immutable, never reused) - a JSON node pointer, not a sid or row. status: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited entered_at: type: string nullable: true touches_done: type: integer minimum: 0 rotations_done: type: integer minimum: 0 error_code: type: string nullable: true description: >- Machine code of the last failure, from the failing task result (max 64). error_message: type: string nullable: true description: Human-readable detail of the last failure (max 1024). last_touch_at: type: string description: >- ISO 8601 UTC - last step advance or status change; the staleness clock. finished_at: type: string nullable: true description: >- ISO 8601 UTC - stamped once when status enters a terminal state; null while live. 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 created_at: type: string updated_at: type: string deleted_at: type: string nullable: true required: - sid - team_sid - workflow_sid - workflow_version_sid - people_sid - entered_via_source_sid - sender_profile_sid - current_step_id - status - entered_at - touches_done - rotations_done - error_code - error_message - last_touch_at - finished_at - created_by - created_at - updated_at - deleted_at included: type: object properties: people: type: object properties: sid: type: string required: - sid description: >- PeopleDomain (1:1 via people_sid) - names/urls for board rendering - see ./people.md. workflow: type: object properties: sid: type: string required: - sid description: >- WorkflowDomain (1:1 via workflow_sid) - see ./workflows.md. sender_profile: type: object nullable: true properties: sid: type: string required: - sid description: >- SenderProfileDomain (1:1 via sender_profile_sid); null when unpinned - see ./sender_profiles.md. workflow_tasks_counts: type: object properties: total_count: type: integer minimum: 0 groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Funnel by WorkflowTaskStatusEnum - this record's execution shape. type: anyOf: - type: object additionalProperties: type: number - type: array items: {} required: - status - type required: - total_count - groups description: >- WorkflowTaskCounts computed over { workflow_record_sid: parent.sid } - status/type distribution of this record's tasks without loading rows (§4.17 parent-include) - see ./workflow_tasks.md. 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: Records matching the filter scope. groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- The funnel axis - map keyed by the 8 WorkflowRecordStatusEnum values. workflow_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-workflow distribution across the team. current_step_id: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Board columns - keys are STRINGIFIED step ids; read with a workflow_sid filter in scope. sender_profile_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-sender load; "null" bucket = unpinned (no send steps). entered_via_source_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-source funnel. required: - status - workflow_sid - current_step_id - sender_profile_sid - entered_via_source_sid 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.