Skip to main content
GET
Get brokerage firm

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

brokerageFirmId
string
required

Brokerage firm id

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

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

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
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

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
preferredPaymentMethodId
string
Pattern: ^payment_method(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$