curl --request GET \
--url https://{instance}/api/export/v1/glossary-terms \
--header 'Authorization: <api-key>'import requests
url = "https://{instance}/api/export/v1/glossary-terms"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://{instance}/api/export/v1/glossary-terms', 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://{instance}/api/export/v1/glossary-terms",
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://{instance}/api/export/v1/glossary-terms"
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://{instance}/api/export/v1/glossary-terms")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/export/v1/glossary-terms")
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<string>{
"error": "<string>"
}{
"error": "<string>"
}Export glossary terms
Export your Business Glossary term definitions, one row per term.
Requires the GLOSSARY_READ permission.
These are the same headers the glossary CSV importer reads, so you can edit an exported file and upload it back.
This endpoint does not accept filter or sort.
| Column | Description |
|---|---|
id | Glossary term identifier. |
name | Term name. |
description | Free-text definition of the term. |
aliases | Alternative names, comma-separated within the cell. |
domain | Name of the domain the term belongs to, if set. |
owner | Email of the term owner, or the user ID for owners without an email. |
classifications | Classifications applied to the term, comma-separated within the cell. |
curl --request GET \
--url https://{instance}/api/export/v1/glossary-terms \
--header 'Authorization: <api-key>'import requests
url = "https://{instance}/api/export/v1/glossary-terms"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://{instance}/api/export/v1/glossary-terms', 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://{instance}/api/export/v1/glossary-terms",
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://{instance}/api/export/v1/glossary-terms"
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://{instance}/api/export/v1/glossary-terms")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/export/v1/glossary-terms")
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<string>{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Your API key's access key and access secret, colon-delimited: <access-key>:<access-secret>. The same header as the GraphQL API; see Authentication.
Query Parameters
A URL-encoded JSON array of glossary term IDs, to export those terms only. Omit it to export every term.
Response
A CSV export with a header row, capped at 100,000 rows. The Content-Disposition header carries a generated filename built from the resource, an optional entity name, and the time range (or today's date if the request has no time bounds).
The response is of type string.