---
title: "Search OAuth clients"
method: POST
path: "/api/oauth-clients/search"
tags: ["oauth_clients"]
---

# Search OAuth clients

`POST /api/oauth-clients/search`

## Request

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

The OAuth applications registered by the caller's team, plus the platform ones (team_sid.is_null true): which apps and agents may ask for access. Filter by status, client_id, actor_kind, registration_kind, is_confidential; include active_sessions to see who is connected through each. No full text: name.eq or client_id.eq. page_size 0 returns the counts only.

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

## Request body

- SearchOauthClientsRequest: Request body of `search_oauth_clients`.
  - `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: Client sid(s).
      - `eq` string
      - `in` string[]
    - `team_sid` object: is_null true = platform clients (owned by no team).
      - `eq` string
      - `in` string[]
      - `is_null` boolean
    - `client_id` object: Exact public identifier.
      - `eq` string
      - `in` string[]
    - `name` object: Exact name.
      - `eq` string
    - `actor_kind` object: agent | integration; is_null true = unclassified legacy clients.
      - `eq` 'agent' | 'integration'
      - `ne` 'agent' | 'integration'
      - `in` string[]
      - `nin` string[]
      - `is_null` boolean
    - `status` object: active | disabled.
      - `eq` 'active' | 'disabled'
      - `in` string[]
    - `is_confidential` object: false = public PKCE clients; true = confidential.
      - `eq` boolean
    - `registration_kind` object: manual | dynamic.
      - `eq` 'manual' | 'dynamic'
      - `in` string[]
    - `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' | '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.

- SearchOauthClientsResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: OAuth client sid (id_oc_...).
      - `team_sid` string, nullable, required: The owning workspace (ts_tm_...); null = a platform client.
      - `name` string, required: The application's name as the consent screen shows it.
      - `client_id` string, required: The public identifier the app presents at /oauth/authorize.
      - `redirect_uris` string[], required: The exact-match https allow-list of callback URLs.
      - `grant_types` string[], required: authorization_code and refresh_token.
      - `permissions` string[], required: The ceiling: the most a grant through this client may hold.
      - `is_confidential` boolean, required: true = a confidential client with a secret; false = public, PKCE only.
      - `registration_kind` 'manual' | 'dynamic', required: manual = registered here; dynamic = registered by the app itself (RFC 7591).
      - `actor_kind` 'agent' | 'integration', nullable, required: agent = its tokens act as an autonomous caller; integration = a tool a person uses; null = unclassified legacy row.
      - `status` 'active' | 'disabled', required: disabled = its grants and tokens are revoked, the flow refuses it.
      - `created_by` object, required: Who registered the client.
        - `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; null = live.
      - `client_secret` string, nullable: The secret of a confidential client, shown ONCE at create; never on a read.
    - `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: Clients matching the filter.
    - `groups` object, required: status, registration_kind, actor_kind, is_confidential: the count per value.

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