List a user's notes

The notes the network left for a user, newest first, as the operator sees them on the user's page.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/system-users/{userId}/notes.do

The notes the network left for a user, newest first, as the operator sees them on the user's page. Each note has id, title (null when it has none), text (plain text, line breaks kept), createdAt, createdBy, updatedAt and updatedBy (ISO-8601 UTC times and the authors' usernames; an author whose user was deleted reads null, and updatedAt/updatedBy stay null until the note is first changed), and readAt (when the user marked it as read, ISO-8601 UTC; null while it is unread). 'editable' says whether the caller may add, change and delete them; 'notesTabVisible' whether the user's role shows the Notes tab, without which the user does not see them. Requires the right to view the user.

Path Params

userId integer required

Numeric id of the user, as /rest-api/system-users/search.do reports it

42

Responses

200

{success, notes: [note], editable, notesTabVisible}

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication error

403

The caller may not view users of the target's role

404

No user with this id

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/42/notes.do")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body