Note groups

Create, read, update and delete note groups, and list the notes each group holds.

Note groups gather notes and the users who share them. You can list, create, read, update and delete groups, and list a group’s notes overall or as one user sees them. This area has 7 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List note groups	GET	/note_groups	Lists the note groups on your instance, one page at a time.
Create a note group	POST	/note_groups	Creates a note group and returns it.
Delete a note group	DELETE	/note_groups/{note_group_id}	Deletes a note group. Nothing comes back.
Retrieve a note group	GET	/note_groups/{note_group_id}	Retrieves one note group by its id.
Update a note group	PATCH	/note_groups/{note_group_id}	Changes a note group and returns it.
List a note group’s notes	GET	/note_groups/{note_group_id}/notes	Lists the notes in one note group, one page at a time.
List a note group’s notes for a user	GET	/note_groups/{note_group_id}/notes/user/{note_user}	Lists a note group’s notes as one of its users sees them.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Writes are wrapped in note_group. One group comes back under the same key.
• Users can be added at create time. Send note_users with a name and an email_address for each.
• version counts changes. After the first update, version is 2.
• A user’s view of the notes takes a uuid or an email address. A user the group does not hold returns 404.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.