Retrieve a note group

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.note_groups.note_groups_dto.NoteGroupsDto.NoteGroup;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<NoteGroup> response = client.noteGroups().getNoteGroup("2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.NoteGroups.GetNoteGroupAsync("2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9");

Console.WriteLine(response.Json);

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().GetNoteGroup(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note_group": {
    "object": "<string>",
    "id": "<string>",
    "status": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "version": 123,
    "href": "<string>",
    "activity_logs": [
      {}
    ]
  }
}

{
  "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}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/note_groups/2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.note_groups.note_groups_dto.NoteGroupsDto.NoteGroup;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<NoteGroup> response = client.noteGroups().getNoteGroup("2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.NoteGroups.GetNoteGroupAsync("2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9");

Console.WriteLine(response.Json);

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().GetNoteGroup(context.Background(), "2d4f6a8c-0e1b-4d3f-a5c7-e9b1d3f5a7c9", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note_group": {
    "object": "<string>",
    "id": "<string>",
    "status": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "version": 123,
    "href": "<string>",
    "activity_logs": [
      {}
    ]
  }
}

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

Returns the note group under note_group. A deleted group returns 404.

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.

Response

The note group, under note_group.

note_group

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response