Notes object via REST API

App Platform
, , ,
1

There’s a notes object that in the FreshDesk app is retrieved via https://bridgewaybentech.freshdesk.com/api/_/companies/xxx/notes?per_page=5

The returned object looks like this:

notes (array)
├── id integer
├── title string
├── created_by string
├── last_updated_by string (nullable)
├── created_at timestamp (ISO 8601)
├── updated_at timestamp (ISO 8601)
├── body string (HTML)
├── company_id integer
├── category_id integer
└── attachments (array)
├── id integer
├── name string
├── content_type string
├── size integer (bytes)
├── created_at timestamp (ISO 8601)
├── updated_at timestamp (ISO 8601)
└── attachment_url string (pre-signed S3 URL, expires in 300 seconds)

meta
├── count integer
└── more_items boolean

Is there any way to retrieve this via the FreshWorks API?

Thanks much!

Mark

2

Hi @burnham,

Welcome to the community! Thanks for the detailed post.

The endpoint you are using (/api/_/) is an internal API and is not part of the official public v2 documentation. I am currently checking with our engineering team to see if there is a supported way to retrieve these specific company notes.

In the meantime, please note the following available options:

  • Ticket Conversations API: This can be used to retrieve notes, but it is strictly limited to those associated with a specific Ticket ID.

  • View Company API: This retrieves core company data but does not currently return a notes array.

I will get back to you shortly with a definitive update on whether a public equivalent for company-level notes exists.

Regards,
Himanshu