Roadmaps API reference

Roadmaps endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 3 days ago

This is the reference for the Roadmaps endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

  • GET /roadmaps: List roadmaps
  • POST /roadmaps: Create a roadmap
  • GET /roadmaps/{roadmapId}: Get a roadmap
  • PATCH /roadmaps/{roadmapId}: Update a roadmap
  • DELETE /roadmaps/{roadmapId}: Delete a roadmap
  • GET /roadmaps/{roadmapId}/posts: List posts in a roadmap
  • GET /roadmaps/{roadmapId}/columns: List roadmap columns
  • POST /roadmaps/{roadmapId}/columns: Create a roadmap column
  • PATCH /roadmaps/{roadmapId}/columns/{columnId}: Update a roadmap column
  • DELETE /roadmaps/{roadmapId}/columns/{columnId}: Delete a roadmap column

List roadmaps

GET /api/v1/roadmaps

Returns all roadmaps in the workspace

Response 200: returns id, name, slug, description, type, baseFilter, dateSource, frequency, visibility, visibleSegmentIds, position, columns, createdAt.

Create a roadmap

POST /api/v1/roadmaps

Create a new roadmap

Request body

Field

Type

Required

Description

name

string

Yes

Roadmap name

slug

string

Yes

URL-friendly slug

description

string

No

Roadmap description

type

string (column, date)

No

baseFilter

object

No

dateSource

string, nullable

No

frequency

string (monthly, quarterly, semiannual), nullable

No

visibility

string (public, team, segment)

No

isPublic

boolean

No

Deprecated: use visibility. false maps to team, true maps to public. Ignored when visibility is sent.

visibleSegmentIds

array of string, nullable

No

columns

array of object

No

Response 201: returns id, name, slug, description, type, baseFilter, dateSource, frequency, visibility, visibleSegmentIds, position, columns, createdAt.

Get a roadmap

GET /api/v1/roadmaps/{roadmapId}

Get a single roadmap by ID

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Roadmap ID

Response 200: returns id, name, slug, description, type, baseFilter, dateSource, frequency, visibility, visibleSegmentIds, position, columns, createdAt.

Update a roadmap

PATCH /api/v1/roadmaps/{roadmapId}

Update an existing roadmap

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Roadmap ID

Request body

Field

Type

Required

Description

name

string

No

description

string, nullable

No

type

string (column, date)

No

baseFilter

object

No

dateSource

string, nullable

No

frequency

string (monthly, quarterly, semiannual), nullable

No

visibility

string (public, team, segment)

No

isPublic

boolean

No

Deprecated: use visibility. false maps to team, true maps to public. Ignored when visibility is sent.

visibleSegmentIds

array of string, nullable

No

columns

array of object

No

Response 200: returns id, name, slug, description, type, baseFilter, dateSource, frequency, visibility, visibleSegmentIds, position, columns, createdAt.

Delete a roadmap

DELETE /api/v1/roadmaps/{roadmapId}

Delete a roadmap by ID

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Roadmap ID

List posts in a roadmap

GET /api/v1/roadmaps/{roadmapId}/posts

Returns posts matching the roadmap view configuration

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Roadmap ID

statusId

query

string

No

Filter by status ID

bucketId

query

string

No

Filter a date roadmap by UTC date bucket

limit

query

integer

No

Items per page

offset

query

integer

No

Offset for pagination

Response 200: returns items, total, hasMore.

List roadmap columns

GET /api/v1/roadmaps/{roadmapId}/columns

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Response 200: returns id, roadmapId, statusId, name, icon, color, position.

Create a roadmap column

POST /api/v1/roadmaps/{roadmapId}/columns

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

Request body

Field

Type

Required

Description

statusId

string

Yes

TypeID - a type-prefixed UUID

name

string

Yes

icon

string

Yes

color

string

Yes

position

number

Yes

Response 201: returns id, roadmapId, statusId, name, icon, color, position.

Update a roadmap column

PATCH /api/v1/roadmaps/{roadmapId}/columns/{columnId}

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

columnId

path

string

Yes

Request body

Field

Type

Required

Description

name

string

No

icon

string

No

color

string

No

position

number

No

Response 200: returns id, roadmapId, statusId, name, icon, color, position.

Delete a roadmap column

DELETE /api/v1/roadmaps/{roadmapId}/columns/{columnId}

Parameters

Name

In

Type

Required

Description

roadmapId

path

string

Yes

columnId

path

string

Yes

Was this helpful?

Your feedback shapes what we write next.

← Previous

Users API reference

Next →

Changelog API reference

Related articles

Build a public roadmapCreate roadmaps that fill themselves from post status, board, tags, and ETA, choose status columns or date periods, and control who can see each one.Posts API referencePosts endpoints of the Quackback REST API: paths, parameters, request fields and responses.Boards API referenceBoards endpoints of the Quackback REST API: paths, parameters, request fields and responses.Statuses API referenceStatuses endpoints of the Quackback REST API: paths, parameters, request fields and responses.