---
title: "List lead score definitions"
method: GET
path: "/lead-scores"
tags: ["Lead Scores"]
---

# List lead score definitions

`GET /lead-scores`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/lead-scores`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/lead-scores/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all lead score definitions for the community.

## Response `200`

OK

- LeadScoreDefinitionList
  - `success` true, required
  - `data` ApiLeadScoreDefinition[], required
    - `id` string, required: Prefixed lead score ID (format `ls_<number>`)
    - `name` string, required: The lead score's display name
    - `enabled` boolean, required: Whether this lead score is currently enabled
    - `entityType` 'contact' | 'organization' | 'object', required: The type of entity this lead score applies to
    - `isPrimaryScore` boolean, required: Whether this is the primary score for its entity type
    - `outputType` 'percentile' | 'point_value', required: The scale this score's value is on. `percentile` scores are filterable with `*LeadScorePercentile`; `point_value` scores hold a raw summed point total and are filterable with `*LeadScorePointValue`. Filtering a score with the wrong key matches nothing.

## Other responses

- `403`: Forbidden
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)