Skip to main content

List roadmap projects

List roadmap projects

Query Parameters
per_page number

Possible values: value ≤ 100

Number of items to return per page (max 100)

offset number

Number of items to skip (for pagination)

created_before date-time

Filter items created before this date (ISO 8601 format)

created_after date-time

Filter items created after this date (ISO 8601 format)

updated_before date-time

Filter items updated before this date (ISO 8601 format)

updated_after date-time

Filter items updated after this date (ISO 8601 format)

assigneeId string

Filter roadmap projects by assignee ID

discoveryId string

Filter roadmap projects by linked discovery ID

select string

Comma-separated list of additional relations to include in response. Available: 'fields', 'discoveries', 'votes'

Responses
200

Return a paginated list of roadmap projects

Schema OPTIONAL
roadmapProjects object[]

Array of roadmap projects

id string

Unique identifier of the roadmap project

clientId string

Client identifier

createdAt date-time

Creation date

updatedAt date-time

Last update date

title string

Title of the project

caption string OPTIONAL

Caption / subtitle

publicDescription string OPTIONAL

Public description

privateDescription string OPTIONAL

Private description

coverImage string OPTIONAL

Cover image URL

coverImageThumbnail string OPTIONAL

Cover image thumbnail URL

progress object

Progress calculated from linked discoveries

started number

Ratio of started discoveries (excl. CLOSED)

finished number

Ratio of finished discoveries (excl. CLOSED)

assignees object[]

Assignees of the project

id string

Unique identifier of the assignee

email string OPTIONAL

Email of the assignee

name string

Name of the assignee

fields object[] OPTIONAL

Custom field values. Only included when select=fields is specified.

field object

The custom field definition

id string

Field ID

clientId string

Field client ID

name string

Field name

type string

Possible values: [SINGLE_SELECT, MULTI_SELECT]

Field type

singleValue object OPTIONAL

Selected option (SINGLE_SELECT fields)

id string

Option ID

clientId string

Option client ID

name string

Option name

multiValues object[] OPTIONAL

Selected options (MULTI_SELECT fields)

id string

Option ID

clientId string

Option client ID

name string

Option name

linkedDiscoveries object[] OPTIONAL

Linked discoveries. Only included when select=discoveries is specified.

id string

Discovery ID

clientId string

Discovery client ID

title string

Discovery title

discoveryStateId string OPTIONAL

Current discovery state ID

votes object[] OPTIONAL

Votes. Only included when select=votes is specified.

id string

Vote ID

value string

Possible values: [BAD, NULL, GOOD]

Vote value

personId string OPTIONAL

Person ID of the voter

email string OPTIONAL

Email of the voter

createdAt date-time

Date of the vote