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

# List provider catalog

> The priced operation registry: every (operation, provider, model) the platform can run, with its name, whether a platform key is configured (callable now), its pricing unit and the price triple (min, expected, max) in credits, whether it is cached, and the web search prices of a model that can search. What a run estimate multiplies (price_expected times the rows) and what the tool pickers render. Team-independent; the platform runs every vendor on its own key and resells the credits.

Contract:
- MCP tool `list_provider_catalog`, registry package `mcp.integrations/provider_calls`, mount `integrations.providers`.
- Operation `action`, response envelope `action`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/integrations/openapi.yaml get /api/provider-catalog
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.integrations'
  description: >-
    The integrations service: the integration platform (the team's credentials
    for its own APIs and its CRM grants, the HTTP tools it defines over them,
    the execution log and the priced catalog of every outbound provider call)
    and the event plane (the platform-wide webhook subscriptions and the
    delivery state of each event).


    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.integrations`, 26
    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/integrations/v1
    description: >-
      Production (the gateway path on the beta ring; the origin is provisioned
      per DEPLOY_MAP.md)
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: custom_tools
    description: >-
      Registry package `mcp.integrations/custom_tools`, served on MCP mount
      `integrations.providers`.
  - name: provider_calls
    description: >-
      Registry package `mcp.integrations/provider_calls`, served on MCP mount
      `integrations.providers`.
  - name: provider_connections
    description: >-
      Registry package `mcp.integrations/provider_connections`, served on MCP
      mount `integrations.providers`.
  - name: webhook_logs
    description: >-
      Registry package `mcp.integrations/webhook_logs`, served on MCP mount
      `integrations.webhooks`.
  - name: webhooks
    description: >-
      Registry package `mcp.integrations/webhooks`, served on MCP mount
      `integrations.webhooks`.
paths:
  /api/provider-catalog:
    get:
      tags:
        - provider_calls
      summary: List provider catalog
      description: >-
        The priced operation registry: every (operation, provider, model) the
        platform can run, with its name, whether a platform key is configured
        (callable now), its pricing unit and the price triple (min, expected,
        max) in credits, whether it is cached, and the web search prices of a
        model that can search. What a run estimate multiplies (price_expected
        times the rows) and what the tool pickers render. Team-independent; the
        platform runs every vendor on its own key and resells the credits.


        Contract:

        - MCP tool `list_provider_catalog`, registry package
        `mcp.integrations/provider_calls`, mount `integrations.providers`.

        - Operation `action`, response envelope `action`.

        - Flags: read only.
      operationId: list_provider_catalog
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProviderCatalogResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    ListProviderCatalogResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item: {}
        result:
          type: object
          properties:
            entries:
              type: array
              items:
                type: object
                properties:
                  operation:
                    type: string
                    enum:
                      - llm.generate
                      - llm.embed
                      - email.find
                      - email.verify
                      - http.request
                      - crm.contact_upsert
                      - crm.company_upsert
                      - crm.associate
                      - crm.properties_list
                      - serp.search
                      - audio.transcribe
                    description: The operation.
                  provider:
                    type: string
                    enum:
                      - openai
                      - anthropic
                      - google
                      - deepseek
                      - xai
                      - voyage
                      - cohere
                      - hunter
                      - findymail
                      - anymailfinder
                      - emaillistverify
                      - custom
                      - hubspot
                      - serper
                    description: The adapter.
                  model:
                    type: string
                    nullable: true
                    description: >-
                      One entry per priced model on llm and audio operations;
                      null elsewhere.
                  name:
                    type: string
                    description: 'Display name (Find email: Hunter).'
                  description:
                    type: string
                    nullable: true
                    description: Display copy for the pickers.
                  platform_key:
                    type: boolean
                    description: >-
                      true = a platform key is configured, callable now; a crm
                      entry has none by design (it runs on the team's grant).
                  pricing_unit:
                    type: string
                    description: >-
                      per_call (the rate is the product's own credit price for
                      the vendor) | per_token (the vendor's dollars per token
                      plus the product's margin, 2026-10-30: a call is billed on
                      its own token counts).
                  price_min:
                    type: number
                    description: >-
                      Credits, a quote with no prompt in hand: a per_call rate;
                      for a per_token entry a short reference call (200 tokens
                      in, 50 out).
                  price_expected:
                    type: number
                    description: >-
                      Credits, the quote of a typical call (1,000 in, 300 out).
                      A row of a Use AI column is priced on its own prompt
                      instead: estimate_playtable_field_ai_cost.
                  price_max:
                    type: number
                    description: >-
                      Credits, the quote of the reference prompt with the
                      model's whole output cap.
                  credits_per_mtok_input:
                    type: number
                    nullable: true
                    description: >-
                      per_token: the credits a million input tokens cost a team,
                      the vendor's price with the margin at the rate; null on a
                      per_call entry.
                  credits_per_mtok_output:
                    type: number
                    nullable: true
                    description: >-
                      per_token: the same for output tokens; 0 where the vendor
                      bills none (an embedding).
                  max_tokens:
                    type: integer
                    nullable: true
                    description: >-
                      per_token: the model's completion cap, the ceiling of a
                      row's price.
                  cacheable:
                    type: boolean
                    description: 'email.find and email.verify: a repeat is free.'
                  web_search:
                    type: boolean
                    description: 'llm.generate: the model can run the vendor''s web search.'
                  price_web_search:
                    type: number
                    nullable: true
                    description: >-
                      Credits per search (the vendor's fee with the margin) on
                      top of the tokens; null when it cannot search.
                  web_search_overhead_tokens:
                    type: integer
                    nullable: true
                    description: >-
                      The prompt tokens the vendor bills for declaring the
                      search tool, searched or not; null when it cannot search.
                  web_search_max_uses:
                    type: integer
                    nullable: true
                    description: >-
                      The searches one call may run at most; null when it cannot
                      search.
                  price_with_web_search_min:
                    type: number
                    nullable: true
                    description: >-
                      The triple of the same call with the search tool declared
                      (its overhead billed searched or not).
                  price_with_web_search_expected:
                    type: number
                    nullable: true
                    description: As above, expected.
                  price_with_web_search_max:
                    type: number
                    nullable: true
                    description: As above, max.
                  default:
                    type: boolean
                    description: >-
                      The one default model of an llm operation (model auto
                      resolves to it).
                  dimensions:
                    type: integer
                    nullable: true
                    description: 'llm.embed: the pinned vector size (1024); null elsewhere.'
                required:
                  - operation
                  - provider
                  - model
                  - name
                  - description
                  - platform_key
                  - pricing_unit
                  - price_min
                  - price_expected
                  - price_max
                  - credits_per_mtok_input
                  - credits_per_mtok_output
                  - max_tokens
                  - cacheable
                  - web_search
                  - price_web_search
                  - web_search_overhead_tokens
                  - web_search_max_uses
                  - price_with_web_search_min
                  - price_with_web_search_expected
                  - price_with_web_search_max
                  - default
                  - dimensions
              description: The catalog, one entry per priced operation.
          required:
            - entries
        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
        - operation
        - action
        - item
        - result
        - 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.