Retrieve user entitlements by user_id
curl --request GET \
--url https://api.example.com/api/entitlements/user-entitlements/{user_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/entitlements/user-entitlements/{user_id}/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/entitlements/user-entitlements/{user_id}/', 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.example.com/api/entitlements/user-entitlements/{user_id}/",
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.example.com/api/entitlements/user-entitlements/{user_id}/"
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.example.com/api/entitlements/user-entitlements/{user_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/entitlements/user-entitlements/{user_id}/")
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{
"meta": {
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
},
"results": [
{
"user_id": 123,
"user_email": "jsmith@example.com",
"entitlement": {
"name": "<string>",
"data_level": "l1",
"exchanges": [
"<string>"
]
},
"status": "PENDING",
"firm_status": "<string>",
"created": "2023-11-07T05:31:56Z"
}
]
}Entitlements
Retrieve user entitlements by user_id
Returns entitlement records for the requested user_id when the user is associated with your firm. Each record includes the overall entitlement status and your firm’s status for that entitlement, when available.
GET
/
api
/
entitlements
/
user-entitlements
/
{user_id}
/
Retrieve user entitlements by user_id
curl --request GET \
--url https://api.example.com/api/entitlements/user-entitlements/{user_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/entitlements/user-entitlements/{user_id}/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/entitlements/user-entitlements/{user_id}/', 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.example.com/api/entitlements/user-entitlements/{user_id}/",
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.example.com/api/entitlements/user-entitlements/{user_id}/"
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.example.com/api/entitlements/user-entitlements/{user_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/entitlements/user-entitlements/{user_id}/")
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{
"meta": {
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
},
"results": [
{
"user_id": 123,
"user_email": "jsmith@example.com",
"entitlement": {
"name": "<string>",
"data_level": "l1",
"exchanges": [
"<string>"
]
},
"status": "PENDING",
"firm_status": "<string>",
"created": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
Trader user id whose entitlement records should be returned.
Response
200 - application/json
Pagination metadata. Use has_next/has_previous for boolean page checks and next/previous for page URLs.
Show child attributes
Show child attributes
Example:
{
"count": 123,
"page": 1,
"page_size": 20,
"total_pages": 7,
"has_next": true,
"has_previous": false,
"next": "https://api.example.org/resources/?page=2",
"previous": null
}
Show child attributes
Show child attributes