Skip to main content
GET
Get Note

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

noteId
string<uuid>
required

Note identifier

Query Parameters

entityType
enum<string>
required

Parent entity type (lowercase kebab-case URL slug), e.g. event, exposure, policy. Selects the per-entity permission enforced for the request and scopes the note to its parent entity. PascalCase (Event) is rejected with a 400 — matching the /entities/{type} path convention.

Available options:
event,
exposure,
quote,
submission,
person,
organization,
policy

Response

Note details

A note attached to a top-level Field Model V1 entity. Notes are simple text records scoped to a parent entity (identified by entityType + entityId). createdByName is resolved from the users table for display.

id
string<uuid>
required

Note identifier

entityType
enum<string>
required

The parent entity type (lowercase kebab-case)

Available options:
event,
exposure,
quote,
submission,
person,
organization,
policy
entityId
string<uuid>
required

The parent entity identifier

note
string
required

The note body

createdAt
string<date-time>
required

When the note was created

updatedAt
string<date-time>
required

When the note was last updated

displayDate
string<date-time> | null

Optional back-datable "as of" date. When set, lists display and sort the note by this date instead of createdAt — intended for historical imports and integrations. The audit timestamps (createdAt/updatedAt) always reflect actual system changes and cannot be overridden.

displayAuthor
string | null

Optional user-visible author label. When set, the note is displayed as authored by this label instead of createdByName — intended for historical imports carrying the source system's author (or a marker like "Data Import"). The audit attribution (createdBy) always reflects the real acting principal and cannot be overridden.

createdBy
string | null

User ID who created the note

createdByName
string | null

Display name of the creating user, resolved for display only

updatedBy
string | null

User ID who last updated the note