Skip to main content
GET
List Brokerages

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

id

Filter by specific brokerage ID(s)

filterText
string

Search across quote number, description, and other text fields

sortBy
enum<string>
default:createdAt

Field to sort by (default createdAt)

Available options:
createdAt,
updatedAt,
name,
email,
defaultCommissionPercentage
sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc
page
integer
default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1

Response

Paginated list of brokerages

items
object[]
totalCount
integer

Total number of matching brokerages across all pages