---
title: "Entities.list"
method: GET
path: "/entities/Entities"
tags: ["Custom Entity"]
---

# Entities.list

`GET /entities/Entities`

## 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/Entities`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Entities/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of Entity 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 Entity records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Entity[]
    - `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.
    - `entity_name` string: Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity").
    - `table_name` string: Storage identifier of the entity. Read-only.
    - `table_ex` string: Storage identifier of the entity's custom-field data. Read-only.
    - `table_data_ex` string: Storage identifier of the entity's option relation data. Read-only.
    - `default_view_field_id` string, uuid, required: Id of the field used as the default display label for records of this entity.
    - `abstract_entity_id` string, required: For sub-entities (e.g. Lead/Opportunity sharing a LeadOppty parent), the entity name of the parent abstract entity. Empty for stand-alone entities.
    - `entity_type` integer, required: Kind of the entity in the platform: business entity, system schema, custom entity, etc.
    - `preference_order` integer, required: Display order used to sort entities in pickers and navigation lists; lower values appear first.
    - `allows_multiple_relation` boolean: True when records of this entity can be linked to multiple records of the same other entity through the same relation.
    - `has_draft` boolean, required: True when records of this entity support drafts (changes go through a draft before being published).
    - `access_mode` integer, required: Access scope of records of this entity: shared across the entire space, scoped to a sales unit, or owner-only.
    - `icon` integer, required: Numeric icon identifier used to render the entity in the UI.
    - `is_deleted` boolean: True when the entity is marked as deleted (soft-delete). Read-only at the entity-metadata level.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `settings` object: Optional space-level configuration for the entity (e.g. UI/feature flags). Empty when no overrides are set.
    - `name_singular` string: Display name of the entity in singular form (e.g. "Account").
    - `name_plural` string: Display name of the entity in plural form (e.g. "Accounts").
  - `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)