Team and roles

List roles (system presets + your custom roles)

Roles define what each team member can see and do in the dashboard and API. A role is a permission map of domain → level:

Domains:

Domain	Covers
`analytics`	Analytics dashboard, audit log
`traders`	Traders, accounts, lockouts, end-of-day snapshots
`payouts`	Payout eligibility, payout execution, payout history
`plans`	Trading plans and trading rules
`webhooks`	Webhook endpoints and deliveries
`operations`	Time machine, revert trading day, bulk operations
`billing`	Billing cycles, events, monthly summary
`team`	Team members and roles
`settings`	Organization profile, API keys

Levels: none (hidden), view (read-only), manage (read + write).

System presets (available to every organization, read-only):

Admin — manage everything
Support — manage traders/accounts and operations, view payout readiness; no billing, team, or settings
Finance — execute payouts, view billing and analytics; read-only accounts
Audit — view everything, change nothing

You can also create custom roles with any combination (POST /organization/roles).

Permissions: requires view access to “Team & roles” (mutations require manage).

Authentication: send your organization API key in the X-API-Key header.

GET

organization

roles

List roles (system presets + your custom roles)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/roles \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/roles', 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/roles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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/roles"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/roles")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "roles": [
      {
        "id": "<string>",
        "name": "Support",
        "description": "<string>",
        "permissions": {},
        "isSystem": true,
        "memberCount": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ]
  }
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Response

System presets and custom roles

success

boolean

Example:

true

data

object

Show child attributes

⌘I

List roles (system presets + your custom roles)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/roles \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/roles', 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/roles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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/roles"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/roles")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "roles": [
      {
        "id": "<string>",
        "name": "Support",
        "description": "<string>",
        "permissions": {},
        "isSystem": true,
        "memberCount": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ]
  }
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

List roles (system presets + your custom roles)

Authorizations

Response