User
Get all agreements
Returns active agreements based on user type. Organization admins see only “organization” category. Organization view-only users cannot access agreements. Regular users see all categories except “organization”.
GET
/
v1
/
user
/
agreements
Get all agreements
curl --request GET \
--url https://api.hyperprop.com/platform/v1/user/agreementsimport requests
url = "https://api.hyperprop.com/platform/v1/user/agreements"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hyperprop.com/platform/v1/user/agreements', 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/user/agreements",
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.hyperprop.com/platform/v1/user/agreements"
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.hyperprop.com/platform/v1/user/agreements")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/agreements")
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{
"success": true,
"data": {
"agreements": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"category": "platform",
"name": "Terms of Service",
"description": "General terms and conditions for using the platform",
"url": "https://hyperprop.com/legal/terms",
"version": "2025-01-15T10:00:00.000Z",
"is_required": true,
"is_active": true,
"sort_order": 1,
"created_at": "2025-01-15T10:00:00.000Z",
"accepted": true,
"accepted_at": "2025-01-20T14:30:00.000Z"
}
]
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "Organization view-only users cannot access agreements",
"code": "ORG_VIEWONLY_NO_AGREEMENTS"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Related topics
Get all dismissalsGet all UI preferencesGet all-months billing aggregatesGet all orders (filled, pending, cancelled)Get all trading accounts for the authenticated user⌘I
Get all agreements
curl --request GET \
--url https://api.hyperprop.com/platform/v1/user/agreementsimport requests
url = "https://api.hyperprop.com/platform/v1/user/agreements"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hyperprop.com/platform/v1/user/agreements', 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/user/agreements",
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.hyperprop.com/platform/v1/user/agreements"
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.hyperprop.com/platform/v1/user/agreements")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/agreements")
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{
"success": true,
"data": {
"agreements": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"category": "platform",
"name": "Terms of Service",
"description": "General terms and conditions for using the platform",
"url": "https://hyperprop.com/legal/terms",
"version": "2025-01-15T10:00:00.000Z",
"is_required": true,
"is_active": true,
"sort_order": 1,
"created_at": "2025-01-15T10:00:00.000Z",
"accepted": true,
"accepted_at": "2025-01-20T14:30:00.000Z"
}
]
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "Organization view-only users cannot access agreements",
"code": "ORG_VIEWONLY_NO_AGREEMENTS"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}