GET
/
beta
/
cards
/
{cardId}
Get card details
curl --request GET \
  --url https://api.vistaly.com/beta/cards/{cardId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "archivedBy": "<string>",
  "assignees": [
    "<string>"
  ],
  "cardDetails": "We need to streamline the onboarding process to reduce drop-off rates",
  "cardId": "abc123def456",
  "cardStatus": "<string>",
  "cardTitle": "Improve customer onboarding",
  "cardType": "assumption",
  "children": [
    {
      "cardId": "<string>",
      "contextId": "<string>"
    }
  ],
  "commentsCount": 123,
  "commentsLastCreatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "endDate": "2023-12-25",
  "jiraIssueId": "<string>",
  "jiraLinked": true,
  "labels": [
    "<string>"
  ],
  "metricCurrent": 123,
  "metricLowerThreshold": 123,
  "metricStart": 123,
  "metricTarget": 123,
  "metricType": "<string>",
  "metricUnit": "<string>",
  "metricUpperThreshold": 123,
  "organizationId": "iLQGOSQFOEIpkYoDgUfQO",
  "parents": [
    {
      "contextId": "<string>",
      "model": "card",
      "id": "<string>"
    }
  ],
  "startDate": "2023-12-25",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "workspaceId": "workspace123"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cardId
string
required

The unique identifier for the card

Response

Card details retrieved successfully

cardId
string
required

The unique identifier of the card

Example:

"abc123def456"

cardTitle
string
required

The title of the card

Example:

"Improve customer onboarding"

cardType
enum<string>
required

The type of the card

Available options:
assumption,
experiment,
kpi,
objective,
opportunity,
outcome,
problem,
product,
solution
organizationId
string
required

The organization ID this card belongs to

Example:

"iLQGOSQFOEIpkYoDgUfQO"

archived
boolean

Whether the card is archived

archivedAt
string<date-time>

When the card was archived

archivedBy
string

User ID who archived the card

assignees
string[]

List of user IDs assigned to this card

cardDetails
string

The detailed description of the card

Example:

"We need to streamline the onboarding process to reduce drop-off rates"

cardStatus
string

The current status of the card

children
object[]

List of child nodes with their card and context IDs

commentsCount
integer

Number of comments on this card

commentsLastCreatedAt
string<date-time>

Timestamp of the last comment

createdAt
string<date-time>

When the card was created

createdBy
string

The user id that created the card

endDate
string<date>

The end date of the card

jiraIssueId
string

Associated Jira issue ID

jiraLinked
boolean

Whether this card is linked to Jira

labels
string[]

List of label IDs associated with this card

metricCurrent
number

Current value for the metric

metricLowerThreshold
number

Lower threshold for the metric

metricStart
number

Starting value for the metric

metricTarget
number

Target value for the metric

metricType
string

Type of metric for outcome/KPI cards

metricUnit
string

Unit of measurement for the metric

metricUpperThreshold
number

Upper threshold for the metric

parents
object[]

List of parent nodes with their context, model, and IDs

startDate
string<date>

The start date of the card

updatedAt
string<date-time>

When the card was last updated

updatedBy
string

The user id that last updated the card

workspaceId
string

The workspace ID this card belongs to

Example:

"workspace123"