Get organization
Retrieve the organization currently in scope.
Without Nxos-On-Behalf-Of, this returns your own organization. With
a valid Nxos-On-Behalf-Of header pointing at a customer org you hold
an active LOA on, this returns that customer org. See
Cross-org access.
curl --request GET \
--url https://api.nxos.io/v1/organizations \
--header 'Authorization: <authorization>'import requests
url = "https://api.nxos.io/v1/organizations"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.nxos.io/v1/organizations', 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.nxos.io/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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.nxos.io/v1/organizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.nxos.io/v1/organizations")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"object": "organization",
"organizationId": "org_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"name": "Acme Trading Co.",
"type": "BUSINESS",
"verificationStatus": "APPROVED",
"createdByOrganizationId": "org_b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
"metadata": {},
"createdAt": "2025-12-01T10:30:00.000Z",
"updatedAt": "2026-03-15T14:30:00.000Z",
"subOrgTier": {
"key": "PLUS",
"label": "Plus",
"spreadBps": 250,
"referrerShareBps": 5000
}
}Headers
Bearer token. Format: Bearer <api_key>
Response
The request has succeeded.
An organization on the platform.
Object type. Always organization.
organization Unique organization identifier.
Display name of the organization.
Legal-entity type.
BUSINESS, INDIVIDUAL Current verification status. The org may transact only when this is APPROVED.
NOT_STARTED, PENDING, APPROVED, REJECTED, ON_HOLD, RESUBMISSION_REQUIRED Organization that created this one via the platform API. null for direct sign-ups (the org created itself through the dashboard).
Caller-supplied metadata. Free-form JSON, max 4 KB serialized and 50 keys.
Show child attributes
Show child attributes
ISO 8601 timestamp when the org was created.
ISO 8601 timestamp of the most recent state change.
Sub-org tier this organization is on, or null when it is on none. Set via
PUT /v1/organizations/sub-org-tier.
referrerShareBps is present only when a broker reads one of its clients
through Nxos-On-Behalf-Of. Reading your own organization omits it: the
share your referrer earns is a term of their agreement with us, not yours.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.nxos.io/v1/organizations \
--header 'Authorization: <authorization>'import requests
url = "https://api.nxos.io/v1/organizations"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.nxos.io/v1/organizations', 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.nxos.io/v1/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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.nxos.io/v1/organizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.nxos.io/v1/organizations")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"object": "organization",
"organizationId": "org_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"name": "Acme Trading Co.",
"type": "BUSINESS",
"verificationStatus": "APPROVED",
"createdByOrganizationId": "org_b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
"metadata": {},
"createdAt": "2025-12-01T10:30:00.000Z",
"updatedAt": "2026-03-15T14:30:00.000Z",
"subOrgTier": {
"key": "PLUS",
"label": "Plus",
"spreadBps": 250,
"referrerShareBps": 5000
}
}