Skip to main content
GET
Get a user note

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

uuid
string
required

UserNote identifier

Response

UserNote resource

A single, attributed note left on a User by HR/Financial staff. Mirrors ContactNote: an append-style thread where each entry records its author and timestamps.

Unlike ContactNote there is no legacy blob to migrate, but $author stays nullable so a deleted staff account (onDelete SET NULL) does not take the note text with it.

Notes are NOT serialized into user_read: that group is served on the plain profile GET, the user list and self-profile-update, so embedding them would expose staff notes to the subject and to peers. They are read only through the UserNote collection, gated by UserNoteCollectionExtension.

Tenant is mapped explicitly (not delegated to the subject user) because UserNote is an API Platform resource: the tenant-isolation Doctrine extensions emit WHERE o.tenant = :tenant, which requires a real column.

text
string
required
Maximum string length: 512
uuid
string | null
action
string | null
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only
authorName
string | null
read-only
authorId
integer | null
read-only
authorLogo
string | null
read-only