List Payees
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/payees \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/payees"
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}/payees', 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}/payees",
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}/payees"
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}/payees")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/payees")
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{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"name": "Smith & Associates Law Firm",
"payeeType": "lawFirm",
"email": "contact@smithlaw.com",
"alternateEmails": [
"billing@smithlaw.com"
],
"phoneNumber": "+1-555-123-4567",
"description": "Defense law firm specializing in insurance litigation",
"address": "123 Legal Plaza, Suite 500, New York, NY 10001",
"addressStructured": {
"streetNumber": "123",
"streetName": "Legal Plaza",
"city": "New York",
"state": {
"short": "NY",
"long": "New York"
},
"postalCode": "10001",
"country": "US"
},
"lawFirmType": "defense",
"bankInfo": {
"bankAccountNumber": "****1234",
"bankRoutingNumber": "****5678"
},
"taxIdNumber": "12-3456789",
"externalPayee": 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"
},
{
"id": "550e8400-e29b-41d4-a716-446655440002",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"name": "Expert Forensics Inc",
"payeeType": "expert",
"email": "info@expertforensics.com",
"alternateEmails": null,
"phoneNumber": "+1-555-987-6543",
"description": "Forensic accounting experts",
"address": null,
"addressStructured": null,
"lawFirmType": null,
"bankInfo": null,
"taxIdNumber": null,
"externalPayee": null,
"createdAt": "2025-01-10T08:00:00.000Z",
"createdBy": "880e8400-e29b-41d4-a716-446655440000",
"updatedAt": null,
"updatedBy": null
}
],
"totalCount": 42
}Payees
List Payees
Returns a paginated list of payees for the company.
Payees are entities that receive payments, such as law firms, experts, vendors, etc. Filter by payee type, ID, or search text, and sort by various fields.
Only returns saved payees (isSaved: true).
Required permission: company.payee:read
GET
/
api
/
external
/
companies
/
{companyId}
/
payees
List Payees
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/payees \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/payees"
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}/payees', 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}/payees",
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}/payees"
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}/payees")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/payees")
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{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"name": "Smith & Associates Law Firm",
"payeeType": "lawFirm",
"email": "contact@smithlaw.com",
"alternateEmails": [
"billing@smithlaw.com"
],
"phoneNumber": "+1-555-123-4567",
"description": "Defense law firm specializing in insurance litigation",
"address": "123 Legal Plaza, Suite 500, New York, NY 10001",
"addressStructured": {
"streetNumber": "123",
"streetName": "Legal Plaza",
"city": "New York",
"state": {
"short": "NY",
"long": "New York"
},
"postalCode": "10001",
"country": "US"
},
"lawFirmType": "defense",
"bankInfo": {
"bankAccountNumber": "****1234",
"bankRoutingNumber": "****5678"
},
"taxIdNumber": "12-3456789",
"externalPayee": 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"
},
{
"id": "550e8400-e29b-41d4-a716-446655440002",
"companyId": "660e8400-e29b-41d4-a716-446655440000",
"name": "Expert Forensics Inc",
"payeeType": "expert",
"email": "info@expertforensics.com",
"alternateEmails": null,
"phoneNumber": "+1-555-987-6543",
"description": "Forensic accounting experts",
"address": null,
"addressStructured": null,
"lawFirmType": null,
"bankInfo": null,
"taxIdNumber": null,
"externalPayee": null,
"createdAt": "2025-01-10T08:00:00.000Z",
"createdBy": "880e8400-e29b-41d4-a716-446655440000",
"updatedAt": null,
"updatedBy": null
}
],
"totalCount": 42
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Query Parameters
Filter by specific payee ID(s)
Filter by payee type Type of payee
Available options:
lawFirm, expert, vendor, other, financingCompany Search across quote number, description, and other text fields
Field to sort by (default createdAt)
Available options:
createdAt, updatedAt, name, email, payeeType Sort direction (default desc)
Available options:
asc, desc Page number (1-based, default 1, page size 50)
Required range:
x >= 1Was this page helpful?
⌘I