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

# Attention: Get Scorecard

> Get Scorecard. Attention Get Scorecard reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Get Scorecard.

<Info>
  Tool ID: `attention_get_scorecard`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'attention_get_scorecard',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute attention_get_scorecard --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "data": {
      "uuid": "uuid_123",
      "title": "VP of Engineering",
      "organizationUUID": "organization_123",
      "allTeams": true,
      "enabled": true,
      "interactionType": "conversation",
      "expertMode": true,
      "isDefaultTemplate": true,
      "createdAt": "2026-01-15T12:00:00Z"
    }
  }
}
```

Use `deepline tools get attention_get_scorecard --json` for the latest machine-readable contract.

## Input reference

Retrieves a single scorecard by its UUID, scoped to the caller's organization. Cross-organization lookups return 404 to prevent existence leaks.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Scorecard UUID |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves a single scorecard by its UUID, scoped to the caller's organization. Cross-organization lookups return 404 to prevent existence leaks.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Scorecard UUID"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Single-resource envelope wrapping a Scorecard. |
| `result.data.data` | `object` | Yes | — | A scorecard template used to evaluate a conversation, chat, or email. |
| `result.data.data.uuid` | `string` | Yes | — | Scorecard UUID. |
| `result.data.data.title` | `string` | Yes | — | Human-readable title of the scorecard (1-128 characters). |
| `result.data.data.organizationUUID` | `string` | Yes | — | UUID of the organization that owns the scorecard. |
| `result.data.data.teamUUID` | `string` | No | — | UUID of the specific team assigned to this scorecard, if any. Mutually exclusive with allTeams=true. |
| `result.data.data.allTeams` | `boolean` | Yes | — | Whether the scorecard is assigned to every team in the organization. |
| `result.data.data.enabled` | `boolean` | Yes | — | Whether the scorecard is active and runs against new interactions. |
| `result.data.data.interactionType` | `"conversation" \| "chat" \| "email"` | Yes | — | Type of interaction the scorecard evaluates. Allowed: `conversation`, `chat`, `email`. |
| `result.data.data.detailedInstructions` | `string` | No | — | Optional free-form guidance appended to the evaluator prompt. |
| `result.data.data.scorecardPrompt` | `string` | No | — | Optional prompt override used in expert mode. |
| `result.data.data.expertMode` | `boolean` | Yes | — | Whether this scorecard uses custom prompts (expert mode) instead of the default template. |
| `result.data.data.isDefaultTemplate` | `boolean` | Yes | — | Whether this scorecard was seeded as one of the default organization templates. |
| `result.data.data.criteria` | `object` | No | — | Label-based criteria that gate when a scorecard is applied to an interaction. |
| `result.data.data.criteria.operator` | `"AND" \| "OR"` | No | — | Boolean operator joining criteria conditions. Allowed: `AND`, `OR`. |
| `result.data.data.criteria.conditions` | `array` | No | — | List of field/value conditions evaluated with the operator. |
| `result.data.data.criteria.conditions[].field` | `string` | No | — | Field path being matched (for example, a label UUID or label option UUID). |
| `result.data.data.criteria.conditions[].value` | `string` | No | — | Expected value for the field to satisfy the condition. |
| `result.data.data.createdAt` | `string` | Yes | — | Timestamp when the scorecard was created. Format: `date-time`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Single-resource envelope wrapping a Scorecard.",
        "properties": {
          "data": {
            "type": "object",
            "description": "A scorecard template used to evaluate a conversation, chat, or email.",
            "properties": {
              "uuid": {
                "type": "string",
                "description": "Scorecard UUID."
              },
              "title": {
                "type": "string",
                "description": "Human-readable title of the scorecard (1-128 characters)."
              },
              "organizationUUID": {
                "type": "string",
                "description": "UUID of the organization that owns the scorecard."
              },
              "teamUUID": {
                "type": "string",
                "description": "UUID of the specific team assigned to this scorecard, if any. Mutually exclusive with allTeams=true."
              },
              "allTeams": {
                "type": "boolean",
                "description": "Whether the scorecard is assigned to every team in the organization."
              },
              "enabled": {
                "type": "boolean",
                "description": "Whether the scorecard is active and runs against new interactions."
              },
              "interactionType": {
                "type": "string",
                "description": "Type of interaction the scorecard evaluates.",
                "enum": [
                  "conversation",
                  "chat",
                  "email"
                ]
              },
              "detailedInstructions": {
                "type": "string",
                "description": "Optional free-form guidance appended to the evaluator prompt."
              },
              "scorecardPrompt": {
                "type": "string",
                "description": "Optional prompt override used in expert mode."
              },
              "expertMode": {
                "type": "boolean",
                "description": "Whether this scorecard uses custom prompts (expert mode) instead of the default template."
              },
              "isDefaultTemplate": {
                "type": "boolean",
                "description": "Whether this scorecard was seeded as one of the default organization templates."
              },
              "criteria": {
                "type": "object",
                "description": "Label-based criteria that gate when a scorecard is applied to an interaction.",
                "properties": {
                  "operator": {
                    "type": "string",
                    "description": "Boolean operator joining criteria conditions.",
                    "enum": [
                      "AND",
                      "OR"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "description": "List of field/value conditions evaluated with the operator.",
                    "items": {
                      "type": "object",
                      "description": "A single criteria condition pairing a field path with an expected value.",
                      "properties": {
                        "field": {
                          "type": "string",
                          "description": "Field path being matched (for example, a label UUID or label option UUID)."
                        },
                        "value": {
                          "type": "string",
                          "description": "Expected value for the field to satisfy the condition."
                        }
                      },
                      "additionalProperties": false
                    }
                  }
                },
                "additionalProperties": false
              },
              "createdAt": {
                "type": "string",
                "description": "Timestamp when the scorecard was created.",
                "format": "date-time"
              }
            },
            "required": [
              "allTeams",
              "createdAt",
              "enabled",
              "expertMode",
              "interactionType",
              "isDefaultTemplate",
              "organizationUUID",
              "title",
              "uuid"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Attention provider guide](/docs/providers/attention/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.