---
title: "Get a scorecard's definition, scope, and ordered rules"
method: GET
path: "/api/rest/v1/scorecards/{id}"
tags: ["Scorecards"]
---

# Get a scorecard's definition, scope, and ordered rules

`GET /api/rest/v1/scorecards/{id}`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/scorecards/{id}`
- Auth: none required

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- RestApiResponseOfScorecardDetail: Standard REST API response envelope for a single resource.
  - `data` ScorecardDetail, required: Scorecard detail view -- the full definition, its scope, and its ordered rules (ADR-011 decision 8). string ScorecardDetail.Status/string? ScorecardDetail.StatusDetail report whether the scope or a rule query currently compiles (ADR-011 decision 6) -- an `Errored` scorecard's prior evaluations still stand, so a report can still be meaningful even while the definition itself needs attention.
    - `id` string, uuid, required
    - `name` string, required
    - `displayName` string, required
    - `description` string, nullable, required
    - `scopeQuery` string, required
    - `enabled` boolean, required
    - `schedule` string, nullable, required
    - `levels` string[], required
    - `status` string, required
    - `statusDetail` string, nullable, required
    - `rules` ScorecardRuleItem[], required
      - `id` string, uuid, required
      - `scorecardId` string, uuid, required
      - `name` string, required
      - `description` string, nullable, required
      - `ruleType` string, required
      - `query` string, nullable, required
      - `weight` union, required
        - integer
        - string, int32
      - `level` string, nullable, required
      - `failureMessage` string, nullable, required
      - `remediationUrl` string, nullable, required
      - `displayOrder` union, required
        - integer
        - string, int32
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `organizationId` string, uuid, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)