List Catalog Carriers

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.usenexio.com/api/v1/catalog/carriers', 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/carriers",
  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/carriers"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.usenexio.com/api/v1/catalog/carriers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "carriers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "carrier_key": "<string>",
      "carrier_id": "<string>",
      "name": "<string>",
      "am_best_rating": "<string>",
      "carrier_type": "<string>",
      "provenance": {
        "source_document_ref": "<string>",
        "effective_year": 123,
        "has_pending_review": true
      }
    }
  ],
  "next_cursor": "<string>"
}

GET

api

catalog

carriers

List Catalog Carriers

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.usenexio.com/api/v1/catalog/carriers', 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/carriers",
  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/carriers"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.usenexio.com/api/v1/catalog/carriers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "carriers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "carrier_key": "<string>",
      "carrier_id": "<string>",
      "name": "<string>",
      "am_best_rating": "<string>",
      "carrier_type": "<string>",
      "provenance": {
        "source_document_ref": "<string>",
        "effective_year": 123,
        "has_pending_review": true
      }
    }
  ],
  "next_cursor": "<string>"
}

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, and runs:test. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

Query Parameters

limit

integer

default:100

Maximum rows to return. Defaults to 100.

Required range: 1 <= x <= 500

cursor

string

Opaque continuation cursor from the prior response.

connection_id

string<uuid>

Restrict the catalog to one active materialize connection.

lob

string

Exact line-of-business label.

state

string

Two-letter state code matched against explicit product eligibility.

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

carrier_key

string

Exact stable carrier entity key.

Response

One page of current carrier heads.

carriers

object[]

required

Show child attributes

next_cursor

string | null

required

Opaque continuation cursor. Null when the walk is exhausted.

Delete Environment List Catalog Products