Fetch a single Note with full HTML body.
curl --request GET \
--url https://production-api.joinrings.com/v1/notes/{note_uuid} \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/notes/{note_uuid}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/notes/{note_uuid}', 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://production-api.joinrings.com/v1/notes/{note_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://production-api.joinrings.com/v1/notes/{note_uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://production-api.joinrings.com/v1/notes/{note_uuid}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/{note_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>",
"uuid": "<string>",
"context": "<string>"
}
],
"content": "<string>",
"created_at": 123,
"date": 123,
"excerpt": "<string>",
"mentions": [
{}
],
"owner_user_uuid": "<string>",
"subject": "<string>",
"updated_at": 123
}Note
Get a note
Tenant-scoped. Returns the full HTML body; if the body can’t be retrieved the response degrades to the stored excerpt rather than erroring.
GET
/
v1
/
notes
/
{note_uuid}
Fetch a single Note with full HTML body.
curl --request GET \
--url https://production-api.joinrings.com/v1/notes/{note_uuid} \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/notes/{note_uuid}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/notes/{note_uuid}', 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://production-api.joinrings.com/v1/notes/{note_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://production-api.joinrings.com/v1/notes/{note_uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://production-api.joinrings.com/v1/notes/{note_uuid}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/{note_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>",
"uuid": "<string>",
"context": "<string>"
}
],
"content": "<string>",
"created_at": 123,
"date": 123,
"excerpt": "<string>",
"mentions": [
{}
],
"owner_user_uuid": "<string>",
"subject": "<string>",
"updated_at": 123
}Authorizations
Path Parameters
Response
200 - application/json
Note read response.
content holds the full HTML body when requested; excerpt is the
plain-text excerpt stored on the note itself, always cheap and safe to
include.