Skip to main content
GET
Get brokerage firm

Path Parameters

brokerageFirmId
string
required

Brokerage firm id

Response

Brokerage firm retrieved successfully.

type
string
required

Entity type

firmType
enum<string>
required

Brokerage firm type

Available options:
WHOLESALE,
RETAIL,
TEAM
id
string
required

Brokerage firm id

companyInfo
object
required

Company info

createdAt
string<date-time>
required

Creation date of brokerage firm

tenantId
string
required

Tenant id

activeProducts
string[]
required

Active products

inactiveProducts
string[]
required

Inactive products

customFields
object[]

custom fields per product

parentBrokerageFirmId
string

Brokerage firm id

preferredPaymentMethodId
string