---
title: "EntityFitnessIndicators.list"
method: GET
path: "/entities/EntityFitnessIndicators"
tags: ["Opportunity"]
---

# EntityFitnessIndicators.list

`GET /entities/EntityFitnessIndicators`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/EntityFitnessIndicators`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/EntityFitnessIndicators/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of EntityFitnessIndicator records, optionally filtered, sorted and limited to selected fields.

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

Page of EntityFitnessIndicator records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` EntityFitnessIndicator[]
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `entity_fitness` string, uri, required: Fitness configuration this indicator belongs to. Related EntityFitness record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EntityFitness' for its fields.
    - `description` string, required: Description of what the indicator measures, shown in the UI.
    - `description_use_lang` boolean, required: When true, description is treated as a translation key and localized in the UI.
    - `entity_fitness_id` string, uuid, required: Id of the fitness configuration.
    - `how_to_fix` string, required: Suggested remediation text shown to the user when a record triggers this indicator.
    - `how_to_fix_use_lang` boolean, required: When true, how_to_fix is treated as a translation key and localized in the UI.
    - `is_enabled` boolean, required: When false, the indicator is configured but not evaluated for records.
    - `name` string, required: Display name of the indicator.
    - `name_use_lang` boolean, required: When true, name is treated as a translation key and localized in the UI; otherwise the literal text is shown.
    - `settings` string, binary, required: Indicator rules. For system indicators contains three thresholds (Notice, Warning, Error); for custom indicators contains user-defined filter rules. This payload conforms to the `FitnessIndicatorSettings` JSON Schema (see the linked schema).
    - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required: Rule the indicator evaluates. Custom indicators use user-defined filter rules and can be deleted; all other values are built-in system indicators with three threshold rules in settings that cannot be deleted. Integer enum value: 1 - Custom, 2 - LowEmailOutreach, 3 - LowEmailEngagement, 4 - TasksOverdue, 5 - NoFollowUp, 6 - ClosingDateOverdue, 7 - SalesStepVelocityOverdue, 8 - SalesCycleOverdue, 9 - ManyClosingDateUpdates, 10 - MovedToPreviousStep, 11 - RankingDecrease, 12 - ValueDecrease
    - `revision` integer: Revision when entity was lastly changed.
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)