Skip to main content
GET
List Catalog Markets

Authorizations

Authorization
string
header
required

Send the credential as Authorization: Bearer <key>.

Scoped partner credentials use the exclusive nxsk_v1_... namespace. Each scoped key is bound at issuance to one organization, one canonical named environment, an explicit engine set, and a least-privilege capability set. A malformed, unknown, rotated, or revoked nxsk_ key fails closed and is never retried as a legacy key.

Capabilities used by this API are runs:write, runs:read, engines:read, catalog:read, webhooks:manage, runs:defensibility:read, runs:test, and converse:use. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

Query Parameters

connection_id
string<uuid>

Pin the browse to one active data connection. Optional when the org has a single active connection; required when it has more than one (an ambiguous request returns catalog_connection_ambiguous).

line
string

Line-of-business filter matched against the product's line or line_code.

state
string

Two-letter state code. Keeps products eligible in the state (not excluded).

Pattern: ^[A-Za-z]{2}$
naics
string

NAICS code to filter by. prohibited_naics and avoided_naics are product-level columns, so the filter drops individual products that prohibit the code (a multi-line market can survive on its other products) and sets avoided: true on products that list it in avoided_naics. The backing columns are populated by an in-flight extraction-quality effort; until then every product reads as non-prohibited.

Case-insensitive substring matched over the line label or market name.

min_commission_pct
number

Minimum commission in percent space (10 = 10%). Keeps a product whose new or renewal rate clears the floor.

Required range: x >= 0
page
integer
default:1

1-based page number. Defaults to 1.

Required range: x >= 1
page_size
integer
default:25

Rows per page, clamped to 100. Defaults to 25.

Required range: 1 <= x <= 100

Response

One page of markets with facets and corpus totals.

items
object[]
required
page
integer
required
page_size
integer
required
total_matched
integer
required

Product-bearing markets matching the active filters.

total_corpus
integer
required

Product-bearing markets in the connection, ignoring filters. The markets list is the set of markets you can transact with, so a market head with no current products is not listed or counted here; it remains reachable by key via GET /catalog/markets/{entity_key}.

facets
object
required