---
title: "CustomEntities.get"
method: GET
path: "/entities/{custom_entity_api_name}/{id}"
tags: ["Custom Entity"]
---

# CustomEntities.get

`GET /entities/{custom_entity_api_name}/{id}`

Returns CustomEntity with given id

## Path parameters

- `custom_entity_api_name` string, required
- `id` string, uuid, required

## Response `200`

CustomEntity data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` CustomEntity
    - `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.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `currency_exchange_rates_list` string, uri — Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.
    - `owner` string, uri, required — Sales user who owns this custom entity record. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `type` string, uri, required — Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. Relation to CustomEntityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntityType' object for properties.
    - `unit` string, uri, required — Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.
    - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this record.
    - `name` string — Name of the entity and its default text representation.
    - `owner_id` string, uuid, required — Id of the record owner.
    - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `table_name` string, required — Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entity_api_name and is used as the entity name in REST and GraphQL queries.
    - `type_id` string, uuid — Id of the custom entity type.
    - `unit_id` string, uuid — Id of the sales unit.
    - `sharing_units` string[] — Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing.
    - `sharing_clients` string[] — Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing.
    - `documents` string[] — Documents linked to this custom entity record.
    - `static_profiles` string[] — Saved view profiles this custom entity record currently matches.
    - `tags` string[] — Tag labels applied to this custom entity record.
    - `is_favorite` boolean, required — True when the current authenticated user has marked this record as favorite. Per-user.
    - `revision` integer — Revision when entity was lastly changed.

## Other responses

- `404` — Sent when invalid ID is given
- `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/versions/e8c12ae60aca/schema)