---
title: "Get Card Metadata"
method: GET
path: "/api/card/{card_id}"
tags: ["Cards"]
---

# Get Card Metadata

`GET /api/card/{card_id}`

Returns the details of a report — what columns it returns and whether any filters are needed before downloading.

## Path parameters

- `card_id` unknown, required

## Response `200`

Full Card metadata including parameters and result_metadata.

- CardMetadata — Details about a report — its columns and any filters it requires.
  - `id` integer — Report ID.
  - `name` string — Report name.
  - `description` string, nullable — What this report measures.
  - `parameters` TemplateTagParameter[] — Filters for this report. Empty means no filters are needed.
    - `name` string — Filter name — use this in the `target` field when downloading.
    - `display_name` string — Filter label.
    - `type` string — Filter type: `"text"`, `"number"`, or `"date"`.
    - `required` boolean — `true` means you must pass a value for this filter when downloading.
    - `default` unknown
  - `result_metadata` ResultMetadataColumn[] — The columns in this report's output.
    - `name` string — Column name.
    - `display_name` string — Column label — this is the key you'll see in JSON downloads.
    - `base_type` string — Data type, e.g. `"type/Text"`, `"type/Integer"`, `"type/DateTime"`.

## Other responses

- `401` — Unauthorized — `x-api-key` header is missing or invalid.
- `403` — Forbidden — your API key doesn't have access to this Card.
- `404` — Card not found.

---

[API](https://skmtc.net/livelike/apis/engagement-suite.md) · [All operations](https://skmtc.net/livelike/apis/engagement-suite/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/livelike/engagement-suite/revisions/f3171d1c30f7/schema)