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

# Entities.list

`GET /entities/Entities`

Returns all defined Entities

## 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`

list of Entities

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Entity[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `entity_name` string — Stable identifier of the entity (e.g. "Account", "Lead", "Opportunity").
    - `table_name` string — Internal storage identifier for the entity. Read-only.
    - `table_ex` string — Internal storage identifier for the entity's custom-field data. Read-only.
    - `table_data_ex` string — Internal storage identifier for the entity's data relation rows. 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 — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)