---
title: "Search API keys"
method: POST
path: "/api/api-keys/search"
tags: ["api_keys"]
---

# Search API keys

`POST /api/api-keys/search`

## Request

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

The team's API keys for an access audit: what each may do, its status, last_used_at and expires_at. status for live vs dead keys, last_used_at.lt for stale keys to revoke at offboarding, expires_at for the ones expiring soon, created_by_actor_sid for what one teammate issued. The secret is never returned (token_prefix and token_last4 only). page_size 0 returns the counts only.

Contract:
- MCP tool `search_api_keys`, registry package `mcp.id/api_keys`, mount `id.access`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchApiKeysRequest: Request body of `search_api_keys`.
  - `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: Key sid(s).
      - `eq` string
      - `in` string[]
    - `status` object: active | revoked | expired.
      - `eq` 'active' | 'revoked' | 'expired'
      - `ne` 'active' | 'revoked' | 'expired'
      - `in` string[]
      - `nin` string[]
    - `name` object: Exact name.
      - `eq` string
    - `created_by_actor_sid` object: Keys a teammate (us_mb_) or a parent key (id_ak_) issued: the offboarding slice.
      - `eq` string
      - `in` string[]
    - `expires_at` object: is_null true = perpetual keys; a range = expiring between.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
      - `is_null` boolean
    - `last_used_at` object: is_null true = never used; lt = stale keys.
      - `gte` string
      - `lte` string
      - `gt` string
      - `lt` string
      - `is_null` boolean
    - `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
  - `sort` object: One column and its direction; omit for the default order.
    - `field` 'created_at' | 'last_used_at' | 'expires_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.

- SearchApiKeysResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: API key sid (id_ak_...).
      - `team_sid` string, required: The workspace the key acts as (ts_tm_...).
      - `name` string, required: Human-readable name, unique among the team's live keys.
      - `token_prefix` string, required: The first characters of the token (gs_live_...), for display.
      - `token_last4` string, required: The last four characters of the token, for display.
      - `permissions` string[], required: What the key may do: the explicit token list.
      - `account_sids` string[], nullable, required: The key's sender slice (ln_ac_...), clamped to its issuer's; null = every account of the issuer's own slice.
      - `status` 'active' | 'revoked' | 'expired', required: active = verifies; revoked | expired = refused.
      - `expires_at` string, nullable, required: ISO 8601 UTC; null = perpetual. Default at creation: three years.
      - `last_used_at` string, nullable, required: ISO 8601 UTC of the last verified call; null = never used.
      - `created_by` object, required: The issuer: a person, or a parent key on delegation.
        - `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.
      - `deleted_at` string, nullable, required: ISO 8601 UTC; set with status revoked.
    - `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: Keys 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)