---
title: "Search teams"
method: POST
path: "/api/teams/search"
tags: ["teams"]
---

# Search teams

`POST /api/teams/search`

## Request

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

The caller's workspaces: the ones they own plus their active memberships. status.eq suspended finds the workspaces with no live share, subscription_sid.is_null the ones nothing pays for, q matches the name. include owner / members_counts. page_size 0 returns the counts only. The capacity a workspace holds is its allocation (search_subscription_allocations on /mcp/id/partner); limits here is its snapshot.

Contract:
- MCP tool `search_teams`, registry package `mcp.id/teams`, mount `id.identity`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchTeamsRequest: Request body of `search_teams`.
  - `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: Team sid(s).
      - `eq` string
      - `in` string[]
    - `owner_user_sid` object: The workspaces a user owns.
      - `eq` string
      - `in` string[]
    - `subscription_sid` object: is_null true = workspaces with no live share (suspended).
      - `eq` string
      - `in` string[]
      - `is_null` boolean
    - `status` object: active | suspended.
      - `eq` 'active' | 'suspended'
      - `ne` 'active' | 'suspended'
      - `in` string[]
    - `q` string: Infix match over the workspace name.
    - `created_at` object: ISO 8601 bounds.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
    - `deleted_at` object: Default scope is { is_null: true } (live rows).
      - `gte` string
      - `lte` string
      - `is_null` boolean
  - `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' | 'updated_at' | 'name', 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.

- SearchTeamsResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: Team sid (ts_tm_...).
      - `owner_user_sid` string, required: The structural owner (us_mb_...): the one who can delete the workspace or hand it over.
      - `subscription_sid` string, nullable, required: The subscription the workspace's live allocation draws from (bl_sb_...); null = no share, suspended.
      - `name` string, required: Workspace name; not unique.
      - `status` 'active' | 'suspended', required: active while its allocation draws from a live subscription; suspended otherwise (settings and billing stay reachable).
      - `plan` 'none' | 'free' | 'paid' | 'partner', nullable, required: none | free (the trial) | paid | partner (a reseller's share).
      - `limits` object, required: The capacity snapshot: the allocation's quantities, zero when there is none.
        - `linkedin_sender_profiles` integer, required: LinkedIn sender profiles (accounts) the workspace may run: its share of the pool.
        - `email_inboxes` integer, required: Inboxes the workspace may connect.
        - `credits_per_month` integer, required: Platform credits granted to the workspace every month of the paid period.
        - `whitelabel` integer, required: 1 = the workspace may register white label brands, 0 = not.
        - `linkedin_seats` integer: Retired on 2026-10-25, always 0 here (linkedin_sender_profiles replaced it).
        - `email_seats` integer: Retired on 2026-10-25, always 0 here (email_inboxes replaced it).
        - `credits_per_period` integer: Retired on 2026-10-25, always 0 here (credits_per_month replaced it).
        - `accounts` integer: A gtm key, 0 on this product.
        - `cloud_browser` integer: A gtm key, 0 on this product.
        - `webhooks` integer: A gtm key, 0 on this product.
        - `proxy_5g` integer: A gtm key, 0 on this product.
      - `cluster_id` integer, nullable, required: The data cluster the workspace was assigned at creation; one cluster today.
      - `config` object, nullable, required: Workspace settings (TeamConfigValue); null when never written.
        - `timezone` string, nullable: IANA zone the workspace counts its day in (Europe/Riga); null = UTC. Defaults to the owner's zone at creation.
      - `created_by` object, required: Who created the workspace.
        - `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.
      - `data_deletion_at` string, nullable, required: When a workspace that lost its coverage is erased (8 weeks after the loss); null while covered.
      - `deletion_warned_at` string, nullable, required: When the owner was warned two weeks ahead of data_deletion_at; null when not yet.
      - `deleted_at` string, nullable, required: ISO 8601 UTC; null = live.
    - `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` number, required: Workspaces matching the filter.
    - `groups` object, required: status: the count per status.

## 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-id.md) - [All operations](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-id/llms.txt) - [OpenAPI document](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-id/revisions/95e48541fe85?raw)