Skip to main content
GET
List roadmap items

Path Parameters

board
enum<string>
required

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

Available options:
hire,
talents
Example:

"hire"

Query Parameters

view
enum<string>
default:ROADMAP_ITEM_VIEW_UNSPECIFIED

AIP-157: BASIC, the default, returns each item's name, slug and updateTime, up to 200 a page; FULL returns whole items, up to 50 a page.

Available options:
ROADMAP_ITEM_VIEW_UNSPECIFIED,
BASIC,
FULL
Example:

"FULL"

filter
string
default:""

AIP-160 restrictions joined by AND: status, kind and area with =, tags and plans with :, and a bare quoted value to search titles, descriptions and tags.

Maximum string length: 1024
Example:

"status = \"PLANNED\" AND tags : \"Scheduling\" AND \"shift swap\""

orderBy
string
default:voteCount desc

AIP-132 order: voteCount, createTime or shipTime, comma-separated, each with an optional desc. Unshipped items sort as the earliest ship time.

Maximum string length: 200
Example:

"voteCount desc, 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 roadmap items.

A page of roadmap items.

items
object[]
required

This page of items, in the view asked for.

A suggestion or a planned change on a roadmap board.

nextPageToken
string
required

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

Example:

"Hq8a1Z3kJ9cY2wQe7Rt0bA"

totalSize
integer

How many items match the filter, across every page.

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

128