List whiteboard sketches on a post
GET /posts/{id}/whiteboards
Returns every sketch saved on the post, newest first, in one list
with no paging. Each is a top-level comment whose annotation_type
is whiteboard, with the drawing in annotation_data and the
title, if any, in body. Deleted sketches are left out.
Replies to a sketch are ordinary comments. They aren’t in this list; they appear in the post’s comment thread, where the sketch is listed too.
You need to be signed in and able to read the post. That’s the same
read check GET /posts/{id} makes, without the mature settings, but
here a post you can’t read answers 404, as one that doesn’t exist or
is deleted does. No capability is needed, and sketches are listed
whether or not the post takes comments.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The post’s id.
Responses
Section titled “ Responses ”The post’s sketches, newest first.
One comment. A reply has parent_id; root_id is the first comment
in its thread and depth counts how far down the thread it is (0
for a top-level comment). Annotations also carry annotation_type
and annotation_data.
A comment written on this instance has author_user_ref; one
received from a paired instance has peer_id and actor_uri
instead. Fields with no value are left out.
object
The local user who wrote the comment. Left out for comments received from another instance.
Normally an empty string: no endpoint except the seed endpoint stores HTML here, comments from other instances don’t carry any, and the web app shows body as plain text. The seed endpoint stores its value unchecked, so don’t display this field as HTML.
object
The paired instance a received comment came from. Left out for comments written on this instance.
The author’s address on their home instance, for example https://studio-b.example/users/bob. Left out for comments written on this instance.
The remote author’s display name. It’s often left out, even for
received comments; when it is, show the host and user name from
actor_uri instead.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Resource not found
object
Human-readable error summary
Example
the request could not be completed