Skip to main content
GET
Get post note

Authorizations

Authorization
string
header
required

Workspace API key from Settings → API Keys.

Path Parameters

post
string<uuid>
required

Post id. A post of another workspace returns 404.

note
string<uuid>
required

Note id. It must belong to the post.

Response

The note.

An internal note on a post. Notes are never published.

id
string<uuid>
post_id
string<uuid>
body
string

The note text. @[user:<id>] mentions a member (their name is in mentions) and @[everyone] mentions everyone who sees the post. An id that is not in mentions belongs to a user who no longer exists.

mentions
object[]

The members the note mentions with @[user:<id>], in no particular order. @[everyone] is not listed here.

reactions
object[]

The note's reactions grouped by emoji, in the order each emoji was first used.

author
object | null
created_at
string

UTC, format Y-m-d H:i:s.

updated_at
string

UTC, format Y-m-d H:i:s.