Skip to main content
GET
/
brokerage-firms
List brokerage firms on tenant
curl --request GET \
  --url https://api.example.com/brokerage-firms
import requests

url = "https://api.example.com/brokerage-firms"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/brokerage-firms', 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://api.example.com/brokerage-firms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/brokerage-firms"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/brokerage-firms")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/brokerage-firms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "type": "<string>",
      "id": "<string>",
      "companyInfo": {
        "siret": "<string>",
        "siren": "<string>",
        "nafCode": "<string>",
        "nafLabel": "<string>",
        "name": "<string>",
        "creationDate": "<string>",
        "location": {
          "city": "<string>",
          "country": "<string>",
          "address": "<string>",
          "postCode": "<string>"
        },
        "legalStatus": {
          "1": "<string>",
          "2": "<string>",
          "3": "<string>"
        },
        "headcount": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "tenantId": "<string>",
      "customFields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "parentBrokerageFirmId": "<string>",
      "preferredPaymentMethodId": "<string>"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Query Parameters

pageInfo
object

the page info

order
object

the sort options

parentBrokerageFirmId
string

Response

200 - application/json

Paginated list of brokerage firms.

data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages