Get Broker
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId} \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}"
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}/brokers/{brokerId}', 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}/brokers/{brokerId}",
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}/brokers/{brokerId}"
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))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}")
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",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"brokerageId": "770e8400-e29b-41d4-a716-446655440000",
"name": "John Smith",
"email": "john.smith@acmeagency.com",
"phone": "+1-555-123-4567",
"workPhone": "+1-555-123-4568",
"addressStructured": {
"line1": "123 Main Street",
"line2": "Suite 100",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"defaultCommissionPercentage": 15,
"producerNumber": "PRD-12345",
"userId": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"createdBy": "880e8400-e29b-41d4-a716-446655440000",
"updatedAt": "2025-01-16T14:20:00.000Z",
"updatedBy": "880e8400-e29b-41d4-a716-446655440000"
}Brokers
Get Broker
Returns a single broker by ID.
Required permission: broker:read
GET
/
api
/
external
/
companies
/
{companyId}
/
brokers
/
{brokerId}
Get Broker
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId} \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}"
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}/brokers/{brokerId}', 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}/brokers/{brokerId}",
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}/brokers/{brokerId}"
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))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId}")
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",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"brokerageId": "770e8400-e29b-41d4-a716-446655440000",
"name": "John Smith",
"email": "john.smith@acmeagency.com",
"phone": "+1-555-123-4567",
"workPhone": "+1-555-123-4568",
"addressStructured": {
"line1": "123 Main Street",
"line2": "Suite 100",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"defaultCommissionPercentage": 15,
"producerNumber": "PRD-12345",
"userId": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"createdBy": "880e8400-e29b-41d4-a716-446655440000",
"updatedAt": "2025-01-16T14:20:00.000Z",
"updatedBy": "880e8400-e29b-41d4-a716-446655440000"
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Broker identifier
Response
Broker details
A broker (individual agent) associated with a brokerage
Broker identifier
Company identifier
The brokerage this broker belongs to
Broker name
Broker email address
Primary phone number
Work phone number
Structured address information
Show child attributes
Show child attributes
Default commission percentage for this broker
Producer number/identifier
Associated user ID (if broker has portal access)
When the broker was created (ISO 8601)
User ID who created the broker
When the broker was last updated (ISO 8601)
User ID who last updated the broker
Was this page helpful?