> ## Documentation Index
> Fetch the complete documentation index at: https://productlane.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the public roadmap

> Returns the public roadmap as the portal renders it. Requires the portal:read scope.



## OpenAPI

````yaml get /portal/roadmap
openapi: 3.0.3
info:
  title: Productlane API
  description: Productlane API v2.
  version: 2.0.0
servers:
  - url: https://productlane.com/api/v2
security: []
paths:
  /portal/roadmap:
    get:
      tags:
        - portal
      summary: Get the public roadmap
      description: >-
        Returns the public roadmap as the portal renders it. Requires the
        portal:read scope.
      operationId: portal-getRoadmap
      parameters:
        - name: contact_email
          in: query
          required: false
          schema:
            type: string
            format: email
          description: >-
            Contact email to evaluate `is_upvoted` against. Without it every
            item returns `is_upvoted: false`.
        - name: language
          in: query
          required: false
          schema:
            type: string
          description: >-
            BCP-47 language code. Merges translations onto the items. Requires
            the Pro plan and the language enabled in workspace settings.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - project
                            - issue
                            - feedback
                        id:
                          type: string
                        project_id:
                          type: string
                          nullable: true
                        linear_project_id:
                          type: string
                          nullable: true
                        name:
                          type: string
                        description:
                          type: string
                        icon:
                          type: string
                          nullable: true
                          description: >-
                            Name of a Nucleo icon (PascalCase, e.g. `Notepad`,
                            `Atom`). Must be a valid icon from
                            https://nucleoapp.com - unknown names will not
                            render in the dashboard or portal.
                        color:
                          type: string
                          nullable: true
                        workspace_id:
                          type: string
                        score:
                          type: number
                        is_upvoted:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        due_date:
                          type: string
                          nullable: true
                        due_date_raw:
                          type: string
                          nullable: true
                        due_date_resolution:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - started
                            - unstarted
                            - backlog
                            - triage
                            - canceled
                            - completed
                            - planned
                          nullable: true
                        status_name:
                          type: string
                          nullable: true
                        status_color:
                          type: string
                          nullable: true
                        linear_roadmap:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - name
                          additionalProperties: false
                          nullable: true
                        sort_order:
                          type: number
                        archived:
                          type: boolean
                        beta_url:
                          type: string
                          nullable: true
                      required:
                        - type
                        - id
                        - name
                        - icon
                        - color
                        - workspace_id
                        - score
                        - is_upvoted
                        - created_at
                        - updated_at
                        - due_date
                        - due_date_raw
                        - due_date_resolution
                        - status
                        - linear_roadmap
                        - sort_order
                        - archived
                      additionalProperties: false
                required:
                  - items
                additionalProperties: false
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````