---
title: "List catalog with your effective prices"
method: GET
path: "/credits/catalog"
tags: ["Catalog"]
---

# List catalog with your effective prices

`GET /credits/catalog`

## Request

- Base URL: `https://api.paywithlocus.com/api`
- URL: `https://api.paywithlocus.com/api/credits/catalog`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Use the default view=compact for normal enterprise catalog browsing. Compact responses omit executable JSON Schemas and model inventories, page providers, carry a version/ETag, and are gzip-compressed when the client advertises gzip. view=dashboard is the Locus Pro dashboard projection; its first page also publishes pageCursors so the dashboard can fetch the remaining pages concurrently. view=summary returns every provider as price-free card metadata and endpoint counts in one response. Agents should stay on compact and follow nextCursor; the 2026-08-31 revision only adds the optional provider secondaryCategories field, the 2026-09-05 revision adds `overridden` and `mcpPinned` to the dashboard endpoint plus the dashboard-only `enabled=true` filter, and the 2026-09-06 revision adds optional endpoint `billingModel` metadata. Personal accounts receive the price-safe dashboard projection when view is omitted or full/compact/dashboard is requested; they may also request summary. Request view=full only for the backward-compatible full export. Cache privately for at most 60 seconds and revalidate with If-None-Match; do not poll more often than once per minute.

## Query parameters

- `view` 'compact' | 'dashboard' | 'summary' | 'full'
- `cursor` string
- `limit` integer
- `enabled` true

## Response `200`

Full export or compact provider page. Responses include ETag, X-Locus-Catalog-Version, and a private no-cache directive so enablement changes are never read from cache.

- union
  - CatalogResponse
    - `success` unknown, required
    - `version` '2026-09-06', required
    - `view` 'full', required
    - `tenant` object, required
      - `defaultMarkupBps` integer, required
      - `defaultFlatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
      - `creditsPerDollar` integer, required
    - `providers` CatalogProvider[], required
      - `provider` string, required
      - `name` string
      - `description` string
      - `category` string
      - `secondaryCategories` string[]: Additional marketplace categories beyond the primary (Parse), so catalogs can file a provider under every category its marketplace lists it in.
      - `verified` boolean
      - `logoUrl` string, uri
      - `iconFallback` object, required
        - `type` 'monogram', required
        - `text` string, required
      - `serviceUrl` string, uri, required
      - `websiteUrl` string, uri
      - `docsUrl` string, uri
      - `catalogPriority` integer
      - `catalogIdentity` string
      - `attribution` object
        - `name` string, required
        - `websiteUrl` string, uri
        - `logoUrl` string, uri
      - `marketplaceRank` integer
      - `marketplaceFeatured` boolean
      - `externalRail` 'mpp' | 'x402'
      - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. Omitted from compact agent projections.
      - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
      - `modelCatalog` InferenceModelCatalog
        - `schemaVersion` '2026-08-01', required
        - `pricingVersion` string, required
        - `provider` string, required
        - `publishedAt` string, date-time, required
        - `freshness` object, required
          - `maxAgeSeconds` integer, required
          - `staleAfter` string, date-time, required
          - `source` 'locus-reviewed-static', required
        - `models` InferenceModelMetadata[], required
          - `id` string, required
          - `status` 'active' | 'deprecated', required
          - `deprecationDate` string, date, nullable, required
          - `contextWindowTokens` integer, required
          - `providerMaxOutputTokens` integer, required
          - `locusMaxOutputTokens` integer, required
          - `recommendedMinOutputTokens` integer, required
          - `pricing` object, required
            - `unit` 'usd_per_1m_tokens', required
            - `input` string, required
            - `output` string, required
          - `capabilities` InferenceModelCapabilities, required
            - `text` boolean, required
            - `vision` boolean, required
            - `tools` boolean, required
            - `json` boolean, required
            - `streaming` boolean, required: Capability of the current Locus credits route, not only the upstream model.
            - `reasoning` boolean, required
          - `request` object, required
            - `outputTokenField` 'max_tokens' | 'max_completion_tokens', required
            - `incompatibleFields` string[], required
      - `endpoints` CatalogEndpoint[], required
        - `slug` string, required
        - `method` string, required
        - `name` string
        - `description` string
        - `estimatedCost` string
        - `billingModel` 'usage' | 'prepaid_runtime': Variable charge collection model; omitted for ordinary fixed-price actions.
        - `inputSchema` object, required: The same usable JSON Schema published by MCP tools/list for this endpoint.
        - `inputExample` object, required: Canonical example arguments accepted by inputSchema.
        - `dynamic` boolean, required
        - `enabled` boolean, required
        - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
        - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
        - `systemManaged` unknown
        - `route` string: Exact execution route for a system-managed capability.
        - `previewRoute` string: No-dispatch estimate route for a system-managed capability.
        - `markupBps` integer, required
        - `overridden` boolean, required
        - `markupSource` 'endpoint' | 'provider' | 'global', required
        - `flatSource` 'endpoint' | 'provider' | 'global', required
        - `flatMarkupUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `flatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `baseUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `chargedUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `marginUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `baseCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `marginCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
  - CompactCatalogResponse
    - `success` unknown, required
    - `version` '2026-09-06', required
    - `view` 'compact', required
    - `tenant` object, required
      - `defaultMarkupBps` integer, required
      - `defaultFlatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
      - `creditsPerDollar` integer, required
    - `providers` CompactCatalogProvider[], required
      - `provider` string, required
      - `name` string
      - `description` string
      - `category` string
      - `secondaryCategories` string[]: Additional marketplace categories beyond the primary (Parse), so catalogs can file a provider under every category its marketplace lists it in.
      - `verified` boolean
      - `logoUrl` string, uri
      - `iconFallback` object, required
        - `type` 'monogram', required
        - `text` string, required
      - `serviceUrl` string, uri, required
      - `websiteUrl` string, uri
      - `docsUrl` string, uri
      - `catalogPriority` integer
      - `catalogIdentity` string
      - `attribution` object
        - `name` string, required
        - `websiteUrl` string, uri
        - `logoUrl` string, uri
      - `marketplaceRank` integer
      - `marketplaceFeatured` boolean
      - `externalRail` 'mpp' | 'x402'
      - `endpoints` CompactCatalogEndpoint[], required
        - `slug` string, required
        - `method` string, required
        - `name` string
        - `description` string
        - `estimatedCost` string
        - `billingModel` 'usage' | 'prepaid_runtime': Variable charge collection model; omitted for ordinary fixed-price actions.
        - `dynamic` boolean, required
        - `enabled` boolean, required
        - `systemManaged` unknown
        - `route` string: Exact execution route for a system-managed capability.
        - `previewRoute` string: No-dispatch estimate route for a system-managed capability.
        - `markupBps` integer, required
        - `overridden` boolean, required
        - `markupSource` 'endpoint' | 'provider' | 'global', required
        - `flatSource` 'endpoint' | 'provider' | 'global', required
        - `flatMarkupUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `flatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `baseUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `chargedUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `marginUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `baseCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `marginCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `nextCursor` string, nullable, required
  - DashboardCatalogResponse: view=dashboard: the compact paging projected to the fields the Locus Pro dashboard renders. Same ETag/cache semantics as CompactCatalogResponse.
    - `success` unknown, required
    - `version` '2026-09-06', required
    - `view` 'dashboard', required
    - `tenant` object, required
      - `defaultMarkupBps` integer, required
      - `defaultFlatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
      - `creditsPerDollar` integer, required
    - `providers` DashboardCatalogProvider[], required
      - `provider` string, required
      - `name` string
      - `description` string
      - `category` string
      - `secondaryCategories` string[]: Additional marketplace categories beyond the primary (Parse), so catalogs can file a provider under every category its marketplace lists it in.
      - `verified` boolean
      - `logoUrl` string, uri, required
      - `serviceUrl` string, uri, required
      - `websiteUrl` string, uri
      - `docsUrl` string, uri
      - `catalogIdentity` string
      - `attribution` object
        - `name` string, required
        - `websiteUrl` string, uri
        - `logoUrl` string, uri
      - `marketplaceRank` integer
      - `marketplaceFeatured` boolean
      - `catalogPriority` integer
      - `externalRail` 'mpp' | 'x402'
      - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
      - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
      - `endpoints` DashboardCatalogEndpoint[], required
        - `slug` string, required
        - `method` string, required
        - `name` string
        - `description` string
        - `estimatedCost` string: Display-only estimate present for dynamic-price endpoints.
        - `billingModel` 'usage' | 'prepaid_runtime': Variable charge collection model; omitted for ordinary fixed-price actions.
        - `dynamic` boolean, required
        - `enabled` boolean, required
        - `mcpPinned` boolean, required
        - `overridden` boolean, required: Markup or flat fee come from a row of this endpoint's own or its provider's, not the workspace default.
        - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
        - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
        - `systemManaged` unknown
        - `route` string
        - `previewRoute` string
        - `markupBps` integer, required
        - `flatMarkupUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `baseUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `chargedUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `marginUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `nextCursor` string, nullable, required
    - `filter` object: Present when the page was narrowed by enabled=true.
      - `enabled` unknown, required
    - `pageCursors` string[]: First page only: the cursor of every following page, so the rest of the walk can be fetched concurrently. Omitted when the walk has more than 100 further pages. A page whose own nextCursor differs from the next published cursor signals a registry change; restart with nextCursor.
  - PersonalDashboardCatalogResponse: Personal-account catalog projection. Upstream cost, margin, markup policy, and pricing provenance are removed at the API boundary.
    - `success` unknown, required
    - `version` '2026-09-06', required
    - `view` 'dashboard', required
    - `tenant` PersonalCatalogTenant, required
      - `creditsPerDollar` integer, required
    - `providers` PersonalCatalogProvider[], required
      - `provider` string, required
      - `name` string
      - `description` string
      - `category` string
      - `secondaryCategories` string[]: Additional marketplace categories beyond the primary (Parse), so catalogs can file a provider under every category its marketplace lists it in.
      - `verified` boolean: Whether the provider listing has been explicitly verified by its source catalog.
      - `logoUrl` string, uri, required
      - `serviceUrl` string, uri, required
      - `websiteUrl` string, uri
      - `docsUrl` string, uri
      - `marketplaceRank` integer
      - `marketplaceFeatured` boolean
      - `externalRail` 'mpp' | 'x402'
      - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
      - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
      - `endpoints` PersonalCatalogEndpoint[], required
        - `slug` string, required
        - `method` string, required
        - `name` string
        - `description` string
        - `dynamic` boolean, required
        - `estimatedCost` string: Display-only quoted range for variable-price actions.
        - `billingModel` 'usage' | 'prepaid_runtime': Variable charge collection model; omitted for ordinary fixed-price actions.
        - `enabled` boolean, required
        - `mcpPinned` boolean, required
        - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
        - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
        - `systemManaged` unknown
        - `chargedUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `effectiveCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `nextCursor` string, nullable, required
    - `filter` object: Present when the page was narrowed by enabled=true.
      - `enabled` unknown, required
    - `pageCursors` string[]
  - DashboardCatalogSummaryResponse
    - `success` unknown, required
    - `version` '2026-09-06', required
    - `view` 'summary', required
    - `tenant` union, required
      - PersonalCatalogTenant
        - `creditsPerDollar` integer, required
      - object
        - `defaultMarkupBps` integer, required
        - `defaultFlatMarkupUsd` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
        - `creditsPerDollar` integer, required
    - `providers` DashboardCatalogSummaryProvider[], required
      - `provider` string, required
      - `name` string
      - `description` string
      - `category` string
      - `secondaryCategories` string[]: Additional marketplace categories beyond the primary (Parse), so catalogs can file a provider under every category its marketplace lists it in.
      - `verified` boolean: Whether the provider listing has been explicitly verified by its source catalog.
      - `logoUrl` string, uri, required
      - `serviceUrl` string, uri, required
      - `websiteUrl` string, uri
      - `docsUrl` string, uri
      - `catalogIdentity` string
      - `attribution` object
        - `name` string, required
        - `websiteUrl` string, uri
        - `logoUrl` string, uri
      - `marketplaceRank` integer
      - `marketplaceFeatured` boolean
      - `catalogPriority` integer: Cross-surface browse priority for deliberately featured providers.
      - `externalRail` 'mpp' | 'x402'
      - `availability` 'available' | 'temporarily_unavailable' | 'unknown': Current platform readiness. This is separate from tenant enablement.
      - `unavailableReason` 'delivery_breaker' | 'platform_pause' | 'null', nullable
      - `endpointCount` integer, required
      - `enabledEndpointCount` integer, required
      - `mutableEndpointCount` integer, required
      - `enabledMutableEndpointCount` integer, required
      - `callableEndpointCount` integer: Enabled endpoints that are currently callable. Present for external rails.

## Other responses

- `304`: The tenant-scoped catalog page is unchanged.

---

[API](https://skmtc.dev/paywithlocus/apis/locus-pro-api.md) - [All operations](https://skmtc.dev/paywithlocus/apis/locus-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paywithlocus/apis/locus-pro-api/revisions/aab8fa5d6cef?raw)