List Users
curl --request GET \
--url https://api.prime.coinbase.com/v1/entities/{entity_id}/usersimport requests
url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/users"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/users', 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.prime.coinbase.com/v1/entities/{entity_id}/users",
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.prime.coinbase.com/v1/entities/{entity_id}/users"
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.prime.coinbase.com/v1/entities/{entity_id}/users")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/users")
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{
"users": [
{
"id": "54496de6-7cbd-4abb-8489-2675c4d1f8f7",
"name": "Frank Malone",
"email": "user@coinbase.com",
"entity_id": "2c521d6c-1cfb-4371-bf9c-5a42938d3e75",
"roles": [],
"secondary_permissions": []
}
],
"pagination": {
"next_cursor": "<string>",
"sort_direction": "DESC",
"has_next": true
}
}Users
List Users
List all users associated with a given entity.
GET
/
v1
/
entities
/
{entity_id}
/
users
List Users
curl --request GET \
--url https://api.prime.coinbase.com/v1/entities/{entity_id}/usersimport requests
url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/users"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/users', 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.prime.coinbase.com/v1/entities/{entity_id}/users",
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.prime.coinbase.com/v1/entities/{entity_id}/users"
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.prime.coinbase.com/v1/entities/{entity_id}/users")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/users")
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{
"users": [
{
"id": "54496de6-7cbd-4abb-8489-2675c4d1f8f7",
"name": "Frank Malone",
"email": "user@coinbase.com",
"entity_id": "2c521d6c-1cfb-4371-bf9c-5a42938d3e75",
"roles": [],
"secondary_permissions": []
}
],
"pagination": {
"next_cursor": "<string>",
"sort_direction": "DESC",
"has_next": true
}
}Entity IDTo retrieve your entity_id, use List Portfolios.
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
UsersService usersService = PrimeServiceFactory.createUsersService(client);
ListUsersRequest request = new ListUsersRequest.Builder()
.entityId("ENTITY_ID_HERE")
.build();
ListUsersResponse response = usersService.listUsers(request);
var usersService = new UsersService(client);
var request = new ListUsersRequest("ENTITY_ID_HERE");
var response = usersService.ListUsers(request);
usersService := users.NewUsersService(client)
request := &users.ListEntityUsersRequest{
EntityId: "ENTITY_ID_HERE",
}
response, err := usersService.ListEntityUsers(context.Background(), request)
prime_client = PrimeClient(credentials)
request = ListUsersRequest(
entity_id="ENTITY_ID_HERE",
)
response = prime_client.list_users(request)
primectl list-entity-users --help
const usersService = new UsersService(client);
usersService.listUsers({
entityId: 'ENTITY_ID_HERE'
}).then(async (response) => {
console.log('Users: ', response);
})
Path Parameters
The entity ID
Query Parameters
Cursor used for pagination (last consumed record)
Number of items to retrieve
Sorting order
Available options:
DESC, ASC Was this page helpful?
⌘I