Organization
Get your organization profile
Retrieve your organization’s public profile information.
What you get:
- Organization name and description
- Contact email for support inquiries
- Website URL
- Logo URL (if uploaded)
Use cases:
- Display your branding in your dashboard or trader portal
- Verify your organization settings are correct
- Check when your profile was last updated
Authentication: Supports dual auth — either a Bearer JWT token (dashboard users) or X-API-Key header (programmatic access). The organization is resolved automatically from the authenticated credential.
GET
/
v1
/
organization
/
profile
Get your organization profile
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/profile \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/profile"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/profile', 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.hyperprop.com/platform/v1/organization/profile",
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: <api-key>"
],
]);
$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.hyperprop.com/platform/v1/organization/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.hyperprop.com/platform/v1/organization/profile")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
"name": "Apex Trading Co",
"description": "Professional prop trading firm specializing in futures and forex",
"contactEmail": "support@apextrading.com",
"websiteUrl": "https://apextrading.com",
"logoUrl": "https://storage.hyperprop.com/logos/apex-trading.png",
"sessionOpenDelayMinutes": 15,
"sessionCloseBufferMinutes": 15,
"commissionPerSide": 2,
"cryptoDayEndTime": "00:00:00",
"cryptoDayEndTimezone": "America/New_York",
"platformPricePerUser": 1.25,
"marketDataPriceCmeGroup": 6.75,
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-20T14:30:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This endpoint is only available for organization users",
"code": "NOT_ORGANIZATION_USER"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Related topics
Update your organization profileGet traders for your organizationGet team members for your organizationGet purchases for your organizationGet trading plans for your organization⌘I
Get your organization profile
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/profile \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/profile"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/profile', 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.hyperprop.com/platform/v1/organization/profile",
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: <api-key>"
],
]);
$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.hyperprop.com/platform/v1/organization/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.hyperprop.com/platform/v1/organization/profile")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
"name": "Apex Trading Co",
"description": "Professional prop trading firm specializing in futures and forex",
"contactEmail": "support@apextrading.com",
"websiteUrl": "https://apextrading.com",
"logoUrl": "https://storage.hyperprop.com/logos/apex-trading.png",
"sessionOpenDelayMinutes": 15,
"sessionCloseBufferMinutes": 15,
"commissionPerSide": 2,
"cryptoDayEndTime": "00:00:00",
"cryptoDayEndTimezone": "America/New_York",
"platformPricePerUser": 1.25,
"marketDataPriceCmeGroup": 6.75,
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-20T14:30:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This endpoint is only available for organization users",
"code": "NOT_ORGANIZATION_USER"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}