List a note group's notes for a user

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9/notes/user/jane%40example.com?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.note_groups.get_note_group_notes_by_user(
    "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", "jane@example.com", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.noteGroups.getNoteGroupNotesByUser(
    '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
    'jane@example.com',
    {limit: 20},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->noteGroups->getNoteGroupNotesByUser(
    '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
    'jane@example.com',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.noteGroups().getNoteGroupNotesByUser(
        "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
        "jane@example.com",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.NoteGroups.GetNoteGroupNotesByUserAsync(
    "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
    "jane@example.com",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.noteGroups.getNoteGroupNotesByUser(
  '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
  'jane@example.com',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.NoteGroups().GetNoteGroupNotesByUser(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", "jane@example.com", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

note_groups

{note_group_id}

notes

user

{note_user}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9/notes/user/jane%40example.com?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.note_groups.get_note_group_notes_by_user(
    "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", "jane@example.com", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.noteGroups.getNoteGroupNotesByUser(
    '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
    'jane@example.com',
    {limit: 20},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->noteGroups->getNoteGroupNotesByUser(
    '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
    'jane@example.com',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.noteGroups().getNoteGroupNotesByUser(
        "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
        "jane@example.com",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.NoteGroups.GetNoteGroupNotesByUserAsync(
    "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9",
    "jane@example.com",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.noteGroups.getNoteGroupNotesByUser(
  '2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9',
  'jane@example.com',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.NoteGroups().GetNoteGroupNotesByUser(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", "jane@example.com", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Name the user by the note user’s uuid, by the uuid of the entity it stands for, or by a manual user’s email address. Returns a page of notes under data, with cursor pagination. A user the group does not hold returns 404. Other fields filter as filter_<field> for equality or filter_<field>_<operator>, such as filter_created_on_gte.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

note_group_id

string

required

The note group's id.

note_user

string

required

The note user's uuid, an entity's uuid, or a manual user's email address.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The pagination.next_cursor of the previous page, to read the page after it.

sort

string

A field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

A page of the notes the user sees.

object

string

Always list.

url

string

The path this page was read from.

data

object[]

The group's notes.

pagination

object

Show child attributes

Guides

API reference

List a note group's notes for a user

Authorizations

Path Parameters

Query Parameters

Response