---
title: "Search SSL certificates"
method: POST
path: "/api/ssl-certificates/search"
tags: ["ssl_certificates"]
---

# Search SSL certificates

`POST /api/ssl-certificates/search`

## Request

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

The team's TLS certificates for its white label domains: each domain's status, issuer, issued_at, expires_at and the last_error token of a failure. status for live vs failed, expires_at.lte for the ones expiring soon, domain.eq for one host. The body and the key are never returned. page_size 0 returns the counts only.

Contract:
- MCP tool `search_ssl_certificates`, registry package `mcp.id/ssl_certificates`, mount `id.partner`.
- Operation `search`, response envelope `search`.
- Flags: read only.

## Request body

- SearchSslCertificatesRequest: Request body of `search_ssl_certificates`.
  - `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: Certificate sid(s).
      - `eq` string
      - `in` string[]
    - `domain` object: Exact FQDN (lowercase).
      - `eq` string
      - `in` string[]
    - `status` object: pending | challenge | active | failed | expired.
      - `eq` 'pending' | 'challenge' | 'active' | 'failed' | 'expired'
      - `ne` 'pending' | 'challenge' | 'active' | 'failed' | 'expired'
      - `in` string[]
      - `nin` string[]
    - `expires_at` object: Expiring soon = { lte: now plus 30 days }.
      - `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' | 'expires_at' | 'issued_at' | 'domain' | 'status', 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.

- SearchSslCertificatesResponse
  - `success` true, required
  - `operation` 'search', required
  - `items` object[], required
    - `item` object, required
      - `sid` string, required: Certificate sid (id_sc_...).
      - `team_sid` string, required: The reseller team (ts_tm_...).
      - `domain` string, required: The brand's host, lowercase FQDN.
      - `status` 'pending' | 'challenge' | 'active' | 'failed' | 'expired', required: pending = registered; challenge = a first issuance in flight; active = serving; failed; expired. A renewal of an active row keeps active.
      - `challenge` object, nullable, required: The attempt in flight (first issuance or renewal); null when none.
        - `type` 'http-01', required: The one challenge type served.
        - `token` string, required: The ACME token the platform serves at well_known_path.
        - `key_authorization` string, required: The key authorization the CA expects there.
        - `well_known_path` string, required: The path the CA fetches on the domain.
        - `cname_target` string, required: The platform host the domain's CNAME must point at.
        - `expires_at` string, nullable, required: ISO 8601 UTC when the authorization lapses at the CA.
      - `issuer` string, nullable, required: The CA that issued the serving certificate; null until one did.
      - `issued_at` string, nullable, required: ISO 8601 UTC; null until issued.
      - `expires_at` string, nullable, required: ISO 8601 UTC the serving certificate lapses; renewed 30 days ahead.
      - `last_error` string, nullable, required: Why the last attempt failed, as a token: domain_not_pointed (fix the CNAME), domain_validation_failed (CAA or other DNS), issuance_unavailable (our side or the CA, contact support). null = none.
      - `created_by` object, required: Who registered the domain (the brand's activation).
        - `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.
    - `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: Certificates 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)