Organization

Get team members for your organization

View all staff members who have access to your organization’s dashboard.

What are team members? Team members are your internal staff who can log into the Hyperprop dashboard to manage your prop firm. This is different from “traders” who are your customers.

Roles: Each member has a role that defines what they can see and do. Roles are permission maps over domains (traders, payouts, billing, team, …) with levels none/view/manage — see GET /organization/roles for the full matrix and system presets (Admin, Support, Finance, Audit).

Members created before roles existed report a legacy role: admin (full access) or viewOnly (read-only). Assign them a real role via PATCH /organization/team/.

What you get for each member:

Email address and display name
Their role (id, name, and effective permission map)
When they joined your organization
Profile avatar (if set)

Use cases:

Audit who has access to your dashboard
Review team member roles before making changes
Onboard new team members by checking existing structure

Permissions: Only admins can view the team member list. View-only members cannot see other team members.

GET

organization

team

Get team members for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/team \
  --header 'Authorization: <api-key>'

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

fetch('https://api.hyperprop.com/platform/v1/organization/team', 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/team",
  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/team"

	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))

}

require 'uri'
require 'net/http'

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

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": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "members": [
      {
        "id": "f994bc02-343c-4026-8a57-afc085eca8d5",
        "email": "sarah@propfirm.com",
        "fullName": "Sarah Johnson",
        "avatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=sarah",
        "role": "admin",
        "joinedAt": "2025-01-15T10:00:00.000Z"
      },
      {
        "id": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
        "email": "mike@propfirm.com",
        "fullName": "Mike Chen",
        "avatarUrl": null,
        "role": "viewOnly",
        "joinedAt": "2025-02-01T09:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can view team members",
  "code": "NOT_ADMIN"
}

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

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Query Parameters

limit

integer

default:50

Results per page (default: 50, max: 100)

Required range: 1 <= x <= 100

offset

integer

default:0

Pagination offset

Required range: x >= 0

cursor

string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

Response

Success - Returns all team members

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "members": [
    {
      "id": "f994bc02-343c-4026-8a57-afc085eca8d5",
      "email": "sarah@propfirm.com",
      "fullName": "Sarah Johnson",
      "avatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=sarah",
      "role": "admin",
      "joinedAt": "2025-01-15T10:00:00.000Z"
    },
    {
      "id": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
      "email": "mike@propfirm.com",
      "fullName": "Mike Chen",
      "avatarUrl": null,
      "role": "viewOnly",
      "joinedAt": "2025-02-01T09:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

⌘I

Get team members for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/team \
  --header 'Authorization: <api-key>'

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

fetch('https://api.hyperprop.com/platform/v1/organization/team', 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/team",
  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/team"

	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))

}

require 'uri'
require 'net/http'

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

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": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "members": [
      {
        "id": "f994bc02-343c-4026-8a57-afc085eca8d5",
        "email": "sarah@propfirm.com",
        "fullName": "Sarah Johnson",
        "avatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=sarah",
        "role": "admin",
        "joinedAt": "2025-01-15T10:00:00.000Z"
      },
      {
        "id": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
        "email": "mike@propfirm.com",
        "fullName": "Mike Chen",
        "avatarUrl": null,
        "role": "viewOnly",
        "joinedAt": "2025-02-01T09:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can view team members",
  "code": "NOT_ADMIN"
}

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

Platform API

Trade API

Market Data API

Get team members for your organization

Authorizations

Query Parameters

Response