Retrieve Notes with the Odie Public API

Retrieve Notes when you need customer context from Odie in reporting or another connected system. The Notes endpoints return published Note content and the records associated with each Note.

Use the Notes endpoints

Task Endpoint
List Notes GET /v1/notes
Retrieve one Note GET /v1/notes/{note_id}

List Notes

curl "https://public-api.us.unison.totango.com/v1/notes?page[limit]=25" \
  --header "Authorization: Bearer <public_api_credential>"

The default page size is 25 Notes and the maximum is 100. Use page[cursor] to request the next page.

Archived Notes are not included in the API response.

Retrieve one Note

curl "https://public-api.us.unison.totango.com/v1/notes/<note_id>" \
  --header "Authorization: Bearer <public_api_credential>"

Understand Note fields

Field Description
id The Note ID.
title The Note title, when present.
content_text The Note body as plain text.
status The current Note status.
created_at When the Note was created.
updated_at When the Note was last updated.
published_at When the Note was published.
created_by Information about the person who created the Note.
associations Records related to the Note.

Interpret Note associations

Each item in associations identifies a related record. The association type can be account, contact, or opportunity. Use its ID to join the Note to data from the related system or endpoint.

FAQs

Do I need to specify a Note type?

No. GET /v1/notes already scopes the response to Notes. Use the association type only to understand which records are connected to each Note.

Does the API return formatted Note content?

The content_text field returns the Note body as plain text.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request