Skip to main content
GET
Get a planning card

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

projectId
string
required

Project id, proj_….

cardId
string
required

Planning card id, card_….

Query Parameters

format
enum<string>
default:markdown

markdown (default) or html. Descriptions are stored as HTML from the web app's editor. Markdown is converted both ways; it drops colours, font sizes and alignment. HTML is sanitised to what the editor itself produces.

Available options:
markdown,
html

Response

OK

id
string
required

Card id, card_….

type
enum<string>
required

planned: work to do, with linkedRuns. run: tracks run.

Available options:
planned,
run
title
string
required
column
object
required
position
number
required

0-based position in the column.

engine
string | null
required

Engine slug the work is planned for; null if none, or for engines the API doesn't expose.

plannedStart
string | null
required

YYYY-MM-DD.

plannedEnd
string | null
required

YYYY-MM-DD.

assignee
object | null
required
createdBy
object
required
run
object | null
required

The run a run card tracks; null for planned cards, or once the run is deleted.

linkedRuns
object[]
required

Runs linked to a planned card, oldest link first.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
format
enum<string>
required
Available options:
markdown,
html
description
string | null
required

The card's description, in format.