Skip to main content
GET
Get your roadmap comment viewer state

Authorizations

Authorization
string
header
required

The session token of a signed-in Plazza account, sent as Authorization: Bearer <token>.

Path Parameters

board
enum<string>
required

The board: hire for employers, talents for job seekers.

Available options:
hire,
talents
Example:

"hire"

item
string<uuid>
required

The item's id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e"

comment
string<uuid>
required

The comment's id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d"

Response

What you did on one comment: private to you. A singleton under the comment.

What you did on one comment: private to you. A singleton under the comment.

name
string
required

The viewer state's resource name, under its comment.

Example:

"roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e/comments/019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d/viewerState"

owned
boolean
required

Whether you wrote the comment.

Example:

false

reactions
enum<string>[]
required

The reactions you gave the comment, oldest first.

One of the four reactions.

Available options:
👍,
❤️,
🎉,
👀
Example: