Get Address Book records
curl --request GET \
--url https://api.bron.org/workspaces/{workspaceId}/address-book-recordsimport requests
url = "https://api.bron.org/workspaces/{workspaceId}/address-book-records"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bron.org/workspaces/{workspaceId}/address-book-records', 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.bron.org/workspaces/{workspaceId}/address-book-records",
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.bron.org/workspaces/{workspaceId}/address-book-records"
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.bron.org/workspaces/{workspaceId}/address-book-records")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bron.org/workspaces/{workspaceId}/address-book-records")
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{
"records": [
{
"createdAt": "1749646207296",
"externalId": "ki50iq4iotxmuv1ihgw9q6u3",
"name": "My address",
"recordId": "gx8df95a09h319dbu79rfora",
"recordType": "address",
"status": "new",
"workspaceId": "e191u51yxnykins6fahd",
"accountIds": [
"<string>"
],
"activatedAt": "1749646207296",
"address": "TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc",
"createdBy": "e191u51yxnykins6fahdizxy",
"email": "<string>",
"imageId": "<string>",
"isFavorite": true,
"labels": "Personal,Business",
"lastUsedAt": "1749646207296",
"memo": "<string>",
"networkId": "BTC",
"tag": "$myworkspace",
"updatedAt": "1749646207296",
"updatedBy": "e191u51yxnykins6fahdizxy"
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Get Address Book records
Retrieve information about crypto addresses in an workspace’s address book
API Key permissions: View only, Transaction Operator, Full AccessGET
/
workspaces
/
{workspaceId}
/
address-book-records
Get Address Book records
curl --request GET \
--url https://api.bron.org/workspaces/{workspaceId}/address-book-recordsimport requests
url = "https://api.bron.org/workspaces/{workspaceId}/address-book-records"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bron.org/workspaces/{workspaceId}/address-book-records', 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.bron.org/workspaces/{workspaceId}/address-book-records",
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.bron.org/workspaces/{workspaceId}/address-book-records"
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.bron.org/workspaces/{workspaceId}/address-book-records")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bron.org/workspaces/{workspaceId}/address-book-records")
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{
"records": [
{
"createdAt": "1749646207296",
"externalId": "ki50iq4iotxmuv1ihgw9q6u3",
"name": "My address",
"recordId": "gx8df95a09h319dbu79rfora",
"recordType": "address",
"status": "new",
"workspaceId": "e191u51yxnykins6fahd",
"accountIds": [
"<string>"
],
"activatedAt": "1749646207296",
"address": "TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc",
"createdBy": "e191u51yxnykins6fahdizxy",
"email": "<string>",
"imageId": "<string>",
"isFavorite": true,
"labels": "Personal,Business",
"lastUsedAt": "1749646207296",
"memo": "<string>",
"networkId": "BTC",
"tag": "$myworkspace",
"updatedAt": "1749646207296",
"updatedBy": "e191u51yxnykins6fahdizxy"
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Path Parameters
Query Parameters
Filter by address book record IDs list
Filter by network IDs
Filter by addresses
Filter by memo
Filter by tag (exact match, case-insensitive)
Limit for pagination
Offset for pagination
Available options:
date-added, type, name Available options:
ASC, DESC Filter by record type. See details
Available options:
address, tag, bank Filter by record types. See details
Available options:
address, tag, bank Filter by statuses. See details
Available options:
new, active, rejected, deleted Filter by label (exact match)
Filter by favorite flag
Include the workspace label dictionary under _embedded.labels
Response
OK
Show child attributes
Show child attributes
Was this page helpful?
