List Catalog Appetite

curl --request GET \
  --url https://api.usenexio.com/api/v1/catalog/appetite \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/catalog/appetite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenexio.com/api/v1/catalog/appetite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenexio.com/api/v1/catalog/appetite"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usenexio.com/api/v1/catalog/appetite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "market_entity_key": "<string>",
      "segment": "<string>",
      "business_class": "<string>",
      "line": "<string>",
      "line_code": "<string>",
      "eligibility": "<string>",
      "confidence": 123,
      "provenance": {
        "source_blob_ref": "<string>",
        "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "effective_from": "2023-11-07T05:31:56Z"
      },
      "signals": {}
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_matched": 123,
  "total_corpus": 123,
  "product_less_markets": 123,
  "product_filter_active": true,
  "facets": {
    "lob": [
      "<string>"
    ]
  },
  "has_prohibited_class_data": true
}

GET

api

catalog

appetite

List Catalog Appetite

curl --request GET \
  --url https://api.usenexio.com/api/v1/catalog/appetite \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/catalog/appetite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenexio.com/api/v1/catalog/appetite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenexio.com/api/v1/catalog/appetite"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usenexio.com/api/v1/catalog/appetite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "market_entity_key": "<string>",
      "segment": "<string>",
      "business_class": "<string>",
      "line": "<string>",
      "line_code": "<string>",
      "eligibility": "<string>",
      "confidence": 123,
      "provenance": {
        "source_blob_ref": "<string>",
        "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "effective_from": "2023-11-07T05:31:56Z"
      },
      "signals": {}
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_matched": 123,
  "total_corpus": 123,
  "product_less_markets": 123,
  "product_filter_active": true,
  "facets": {
    "lob": [
      "<string>"
    ]
  },
  "has_prohibited_class_data": true
}

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, conversations:use, and conversations:export. 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).

business_class

string

Exact appetite business-class label.

state

string

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

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

line

string

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

eligibility

string

Appetite eligibility value (acceptable, will_consider, or not_a_market).

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 appetite cells.

items

object[]

required

Show child attributes

page

integer

required

page_size

integer

required

total_matched

integer

required

total_corpus

integer

required

product_less_markets

integer | null

required

Always null here. The product-less-market disclosure is a markets-grain fact; see CatalogMarketListResponse.

product_filter_active

boolean

required

Always false here; the appetite page takes its own filter set.

facets

object

required

Show child attributes

has_prohibited_class_data

boolean

required

True when at least one current product in the connection carries an extracted prohibited-class list (data presence, not extraction coverage). Consumer rules: an empty per-product prohibited_naics never renders as "no prohibited classes", regardless of this flag (a default-empty row and an extracted-none row are indistinguishable); while the flag is false, additionally disclose that prohibited-class data is not yet extracted for this corpus.

Start Here

Guides

API Reference

List Catalog Appetite

Authorizations

Query Parameters

Response