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

> Read the human work queue: the manual tasks (ub_tk_) that threads spawn and that users write for themselves. state.eq open plus assignee_user_sid.eq is one person's plate, in the default due_at asc order; conversation_sid.eq is one thread's cards; due_at.lte now over open rows is the overdue set. page_size 0 returns counts only (total_count, overdue_count and the state axis). NOT the machine lane: automated step attempts are playtables workflow tasks (search_workflow_tasks).

Contract:
- MCP tool `search_tasks`, registry package `mcp.unibox/tasks`, mount `unibox.inbox`.
- Operation `search`, response envelope `search`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/unibox/openapi.yaml post /api/tasks/search
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.unibox'
  description: >-
    The team inbox and the AI SDR: every LinkedIn and email thread in one place
    (conversations, messages, the timeline events), the manual tasks a thread
    spawns, the sender profiles the team speaks through with their LinkedIn
    account and mailboxes, and the one agent per team with its scenarios, plans
    and runs.


    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.unibox`, 125 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/unibox/v1
    description: >-
      Production (the gateway path on the beta ring; the origin is provisioned
      per DEPLOY_MAP.md)
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: agent_answers
    description: >-
      Registry package `mcp.unibox/agent_answers`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_conversation_uploads
    description: >-
      Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP
      mount `unibox.agent-memory`.
  - name: agent_examples
    description: >-
      Registry package `mcp.unibox/agent_examples`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_hints
    description: >-
      Registry package `mcp.unibox/agent_hints`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_plans
    description: >-
      Registry package `mcp.unibox/agent_plans`, served on MCP mount
      `unibox.agent`.
  - name: agent_runs
    description: >-
      Registry package `mcp.unibox/agent_runs`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_scenarios
    description: >-
      Registry package `mcp.unibox/agent_scenarios`, served on MCP mount
      `unibox.agent`.
  - name: agent_source_parses
    description: >-
      Registry package `mcp.unibox/agent_source_parses`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_sources
    description: >-
      Registry package `mcp.unibox/agent_sources`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_tests
    description: >-
      Registry package `mcp.unibox/agent_tests`, served on MCP mount
      `unibox.agent-memory`.
  - name: agents
    description: >-
      Registry package `mcp.unibox/agents`, served on MCP mount
      `unibox.website`.
  - name: conversation_events
    description: >-
      Registry package `mcp.unibox/conversation_events`, served on MCP mount
      `unibox.inbox`.
  - name: conversations
    description: >-
      Registry package `mcp.unibox/conversations`, served on MCP mount
      `unibox.inbox`.
  - name: messages
    description: >-
      Registry package `mcp.unibox/messages`, served on MCP mount
      `unibox.inbox`.
  - name: sender_profiles
    description: >-
      Registry package `mcp.unibox/sender_profiles`, served on MCP mount
      `unibox.sender-profiles`.
  - name: tasks
    description: Registry package `mcp.unibox/tasks`, served on MCP mount `unibox.inbox`.
  - name: timeline
    description: >-
      Registry package `mcp.unibox/timeline`, served on MCP mount
      `unibox.inbox`.
paths:
  /api/tasks/search:
    post:
      tags:
        - tasks
      summary: Search tasks
      description: >-
        Read the human work queue: the manual tasks (ub_tk_) that threads spawn
        and that users write for themselves. state.eq open plus
        assignee_user_sid.eq is one person's plate, in the default due_at asc
        order; conversation_sid.eq is one thread's cards; due_at.lte now over
        open rows is the overdue set. page_size 0 returns counts only
        (total_count, overdue_count and the state axis). NOT the machine lane:
        automated step attempts are playtables workflow tasks
        (search_workflow_tasks).


        Contract:

        - MCP tool `search_tasks`, registry package `mcp.unibox/tasks`, mount
        `unibox.inbox`.

        - Operation `search`, response envelope `search`.

        - Flags: read only.
      operationId: search_tasks
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTasksRequest'
      responses:
        '200':
          description: '`search` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTasksResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    SearchTasksRequest:
      type: object
      description: Request body of `search_tasks`.
      properties:
        filter:
          type: object
          properties:
            sid:
              type: object
              properties:
                eq:
                  type: string
                  minLength: 18
                  maxLength: 18
                  pattern: ^ub_tk_
                  description: Task sid (ub_tk_…).
                in:
                  type: array
                  items:
                    type: string
                    minLength: 18
                    maxLength: 18
                    pattern: ^ub_tk_
                    description: Task sid (ub_tk_…).
              additionalProperties: false
              description: >-
                Task sid(s), ub_tk_ prefix - also the point lookup (there is no
                get tool).
            conversation_sid:
              type: object
              properties:
                eq:
                  type: string
                  minLength: 18
                  maxLength: 18
                  pattern: ^ub_cv_
                  description: Conversation sid (ub_cv_…) - the thread the task hangs on.
                in:
                  type: array
                  items:
                    type: string
                    minLength: 18
                    maxLength: 18
                    pattern: ^ub_cv_
                    description: Conversation sid (ub_cv_…) - the thread the task hangs on.
                is_null:
                  type: boolean
              additionalProperties: false
              description: Owning thread(s); is_null true = standalone tasks.
            person_sid:
              type: object
              properties:
                eq:
                  type: string
                  minLength: 18
                  maxLength: 18
                  pattern: ^cr_pp_
                  description: Person sid (cr_pp_…, external - playtables).
                in:
                  type: array
                  items:
                    type: string
                    minLength: 18
                    maxLength: 18
                    pattern: ^cr_pp_
                    description: Person sid (cr_pp_…, external - playtables).
                is_null:
                  type: boolean
              additionalProperties: false
              description: Tasks about one playtables person, off the creation-time denorm.
            state:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                    - open
                    - done
                    - canceled
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - open
                      - done
                      - canceled
              additionalProperties: false
              description: open | done | canceled. The Tasks view scope is open.
            assignee_user_sid:
              type: object
              properties:
                eq:
                  type: string
                  minLength: 18
                  maxLength: 18
                  description: User sid (us_mb_…, external - gs.service.id).
                in:
                  type: array
                  items:
                    type: string
                    minLength: 18
                    maxLength: 18
                    description: User sid (us_mb_…, external - gs.service.id).
                is_null:
                  type: boolean
              additionalProperties: false
              description: Owner of the work ("my tasks"); is_null true = unassigned.
            due_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                is_null:
                  type: boolean
              additionalProperties: false
              description: >-
                ISO 8601 bounds; lte now over open rows = the overdue set,
                is_null true = undated.
            created_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
              description: ISO 8601 range; combine bounds in one object.
            deleted_at:
              type: object
              properties:
                is_null:
                  type: boolean
              additionalProperties: false
              description: >-
                Default scope is { is_null: true } (live rows); stating it at
                all lifts the soft-delete scope.
          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:
              - conversation
            description: >-
              The owning thread, hydrated once per page; null on a task without
              a thread.
          description: Relations to attach to every item; omit for the bare rows.
        sort:
          type: object
          properties:
            field:
              type: string
              enum:
                - due_at
                - created_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.
    SearchTasksResponse:
      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
                    description: Task sid (ub_tk_…).
                  team_sid:
                    type: string
                    description: Owning team (ts_tm_…, external - gs.service.id).
                  title:
                    type: string
                    description: One line stating the work, 1..255 chars.
                  state:
                    type: string
                    enum:
                      - open
                      - done
                      - canceled
                    description: >-
                      open = on the queue; done = completed (completed_at
                      stamped); canceled = discarded. There is no delete.
                  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
                    description: >-
                      Actor that opened the task. actor_type user = a person,
                      agent = the AI SDR (escalation or a plan step), system =
                      the workflow bridge.
                  conversation_sid:
                    type: string
                    nullable: true
                    description: >-
                      The thread this task hangs on (ub_cv_…); null =
                      standalone, which no inbox surface lists yet.
                  person_sid:
                    type: string
                    nullable: true
                    description: >-
                      The playtables person the thread was linked to AT CREATION
                      (cr_pp_…) - a denorm, never backfilled by later linking;
                      null when the thread had no primary link.
                  body:
                    type: string
                    nullable: true
                    description: >-
                      Free text. On agent-created rows this is the context
                      bundle: why a human is needed, plus the facts to act
                      without re-reading the thread.
                  due_at:
                    type: string
                    nullable: true
                    description: >-
                      ISO 8601 UTC deadline; null = undated. Once it passes, the
                      due sweep (every 5 minutes) flips the owning thread to
                      needs_you: the "Task due" cue.
                  assignee_user_sid:
                    type: string
                    nullable: true
                    description: >-
                      User expected to do the work (us_mb_…, external -
                      gs.service.id); null = unassigned. A label, not a lock.
                  completed_at:
                    type: string
                    nullable: true
                    description: >-
                      ISO 8601 UTC; stamped on open -> done and cleared on
                      reopen. Null while open, and on a canceled task.
                  workflow_task_sid:
                    type: string
                    nullable: true
                    description: >-
                      The playtables manual_task / manual_router node this
                      co-pilot task stands for (wf_tk_…), set only by the
                      internal bridge; null on tasks people and the agent open.
                      Closing such a task reports the outcome back to
                      playtables.
                  options:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          minimum: 1
                          description: >-
                            Arm id, unique inside this task; echoed back as
                            chosen_option_id on completion.
                        label:
                          type: string
                          description: >-
                            What the arm says to the human (1..255 chars) - the
                            router branch, in authored order; on a play's
                            question the plain English fallback of the choice.
                        key:
                          type: string
                          nullable: true
                          maxLength: 32
                          description: >-
                            A play's question only: the choice the option stands
                            for (remove | keep | move about a journey the play
                            paused, add for a person in none). Absent on a
                            router's arm.
                      required:
                        - id
                        - label
                    description: >-
                      The arms a manual_router node offers (1..9, authored
                      order); null on every other task. Non-null means this task
                      completes WITH a pick.
                  chosen_option_id:
                    type: integer
                    nullable: true
                    description: >-
                      The picked arm, set with the open -> done transition of a
                      task that carries options; null otherwise, and cleared on
                      reopen.
                  expires_at:
                    type: string
                    nullable: true
                    description: >-
                      ISO 8601 UTC; a task still open at this instant is
                      canceled by the sweep (every 5 minutes) and keeps the
                      instant, which is how an expired task reads (canceled WITH
                      expires_at). A close by a person clears it; null = it
                      never expires. A task the product opens itself (the AI
                      SDR's, a hand-over's, a workflow node's) takes a month by
                      default; a live visit alert takes its site's
                      live_alert_task_minutes.
                  source_ref:
                    type: string
                    nullable: true
                    description: >-
                      What produced a system task, <source>:<its sid>:
                      escalation:ub_cv_... the AI SDR's hand-off,
                      website_live:sg_ws_... a live visit alert. null on a
                      person's task. Read-only.
                  kind:
                    type: string
                    enum:
                      - manual
                      - play_draft
                      - play_question
                    description: >-
                      manual = a person's, the agent's or a workflow node's work
                      item (every task until 2026-10-14); play_draft = a play's
                      draft (a congratulation, a comment, a person entering a
                      workflow) whose words wait in draft, Send approves them as
                      edited and Skip (canceled) drops them; play_question = a
                      play's question about a journey (remove | keep | move) or
                      a person in none (add), answered with a chosen option. Set
                      by the bridge; read-only.
                  draft:
                    type: string
                    nullable: true
                    description: >-
                      A play's draft: the words the person sends, as edited
                      before Send (update draft, then state=done, or both at
                      once); null on every other task.
                  play_ref:
                    type: object
                    nullable: true
                    properties:
                      play_sid:
                        type: string
                        description: The play (pt_pl_..., external - playtables).
                      play_name:
                        type: string
                        description: Display denorm, frozen when the task opened.
                      playtable_sid:
                        type: string
                        nullable: true
                        description: >-
                          The table the play lives in (pt_tb_...), the way into
                          its playbook; null when unknown.
                      workflow_sid:
                        type: string
                        nullable: true
                        description: >-
                          The workflow the act names (a person entering it, a
                          move's destination) when the play named one, or the
                          one the person picked on a question whose choice needs
                          one (move, add); null until then.
                    required:
                      - play_sid
                      - play_name
                      - playtable_sid
                      - workflow_sid
                    description: >-
                      A play's task: the play, its table and the workflow the
                      act names or the person picked; null on every other task.
                  created_at:
                    type: string
                    description: ISO 8601 UTC.
                  updated_at:
                    type: string
                    description: ISO 8601 UTC; bumped by every edit and state move.
                  deleted_at:
                    type: string
                    nullable: true
                    description: >-
                      ISO 8601 UTC; null = live. No writer in v1 (canceled is
                      the discard), so this stays null.
                required:
                  - sid
                  - team_sid
                  - title
                  - state
                  - created_by
                  - conversation_sid
                  - person_sid
                  - body
                  - due_at
                  - assignee_user_sid
                  - completed_at
                  - workflow_task_sid
                  - options
                  - chosen_option_id
                  - expires_at
                  - source_ref
                  - kind
                  - draft
                  - play_ref
                  - created_at
                  - updated_at
                  - deleted_at
              included:
                type: object
                properties:
                  conversation:
                    type: object
                    additionalProperties: {}
                    description: >-
                      Owning thread row (ConversationDomain -
                      entities/conversations.md); null when the task has no
                      thread.
            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: Tasks matching the filter (full filter scope, not the page).
            overdue_count:
              type: integer
              minimum: 0
              description: Of those, the open rows whose due_at is already past.
            groups:
              type: object
              properties:
                state:
                  anyOf:
                    - type: object
                      properties:
                        open:
                          type: integer
                          minimum: 0
                        done:
                          type: integer
                          minimum: 0
                        canceled:
                          type: integer
                          minimum: 0
                    - type: array
                      items: {}
                  description: >-
                    Task distribution across the three states; an absent key =
                    zero.
              required:
                - state
          required:
            - total_count
            - overdue_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.