Get Brokerage

curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}', 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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}",
  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: <api-key>"
  ],
]);

$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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}"

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

	req.Header.Add("Authorization", "<api-key>")

	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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Acme Insurance Agency",
  "commissionPaymentMethod": "agencyBill",
  "niprBrokerageNumber": "12345678",
  "email": "contact@acmeagency.com",
  "addressStructured": {
    "line1": "123 Main Street",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "phone": "+1-555-123-4567",
  "defaultCommissionPercentage": 15,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-16T14:20:00.000Z"
}

GET

api

external

companies

{companyId}

brokerages

{brokerageId}

Get Brokerage

curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}', 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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}",
  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: <api-key>"
  ],
]);

$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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}"

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

	req.Header.Add("Authorization", "<api-key>")

	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://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Acme Insurance Agency",
  "commissionPaymentMethod": "agencyBill",
  "niprBrokerageNumber": "12345678",
  "email": "contact@acmeagency.com",
  "addressStructured": {
    "line1": "123 Main Street",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "phone": "+1-555-123-4567",
  "defaultCommissionPercentage": 15,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-16T14:20:00.000Z"
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId

string<uuid>

required

Company identifier

brokerageId

string<uuid>

required

Brokerage identifier

Response

Brokerage details

A brokerage (insurance agency or broker) in the system

string<uuid>

Brokerage identifier

name

string

Brokerage name

commissionPaymentMethod

enum<string>

Method for handling commission payments

Available options:

agencyBill,

directBill,

doNotHandle

niprBrokerageNumber

string | null

NIPR brokerage number

string<email> | null

Brokerage email address

addressStructured

object | null

Structured address information

Show child attributes

phone

string | null

Phone number

defaultCommissionPercentage

number | null

Default commission percentage for this brokerage

createdAt

string<date-time> | null

When the brokerage was created (ISO 8601)

updatedAt

string<date-time> | null

When the brokerage was last updated (ISO 8601)

Create Brokerage Update Brokerage

⌘I

Getting Started

Submissions

Quotes

Assignees

Notes

Events

Brokerages

Brokers

Payees

Transaction Categories

Event Financials

Policies

Exposures

Attorneys

Lawsuits

Defendants

Configuration Fields

Configuration Rating Fields

Configuration Rating Outputs

Configuration Rating Presets

Configuration Rating Form Logic

Configuration Presets

Exposure Types

Coverage Types

Smart Tags

Address

Reference

Get Brokerage

Authorizations

Path Parameters

Response