Get brokerage firm
brokerage-firms
Get brokerage firm
Retrieves a brokerage firm by id including configuration and metadata.
GET
Get brokerage firm
Authorizations
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
Your tenant identifier. Requests without it are rejected.
Path Parameters
Brokerage firm id
Pattern:
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Response
Brokerage firm retrieved successfully.
Entity type
Brokerage firm type
Available options:
WHOLESALE, RETAIL, TEAM Brokerage firm id
Pattern:
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Company info
Creation date of brokerage firm
Tenant id
Active products
Inactive products
custom fields per product
Brokerage firm id
Pattern:
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Pattern:
^payment_method(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
