Skip to main content
GET
List roadmap comments

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"

Query Parameters

filter
string
default:""

Empty lists the top-level comments. parent = "<comment name>" lists the replies to that comment.

Maximum string length: 1024
Example:

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

orderBy
enum<string>
default:createTime

Oldest first, or newest first with createTime desc.

Available options:
createTime,
createTime desc
Example:

"createTime desc"

pageSize
integer
default:0

How many results to return at most. Zero or none uses the default; a larger value than the maximum returns the maximum.

Required range: 0 <= x <= 9007199254740991
Example:

20

pageToken
string
default:""

The nextPageToken of the previous page, to read the next one. Keep every other parameter the same.

Maximum string length: 2048
Example:

"Hq8a1Z3kJ9cY2wQe7Rt0bA"

Response

A page of comments.

A page of comments.

comments
object[]
required

This page of comments.

nextPageToken
string
required

Pass it as pageToken to read the next page. Empty on the last page.

Example:

"Hq8a1Z3kJ9cY2wQe7Rt0bA"