---
title: "Profiles.get"
method: GET
path: "/entities/Profiles/{id}"
tags: ["Profile"]
---

# Profiles.get

`GET /entities/Profiles/{id}`

Returns Profile with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Profile data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Profile
    - `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.
    - `owner` string, uri, required — User who owns the screen profile. 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.
    - `sync_entity` string, uri — Specific record this profile is synchronized to. Set only when sync_enabled is true. Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties.
    - `entity` 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Pipelinescreen, 2 - Timelinescreen, 3 - Archivescreen, 4 - Leadscreen, 6 - Accountscreen, 7 - Contactscreen, 8 - Activityscreen, 9 - Feedscreen, 10 - Hrmscreen, 11 - Auditscreen, 12 - Navigator, 13 - Insightsscreen, 14 - Indicatorsscreen, 15 - Conversionsscreen, 16 - Lifecyclescreen, 17 - Feedscreen2, 18 - ProductScreen, 19 - Projectscreen, 20 - Forecastscreen, 21 - LeadArchivescreen, 22 - TargetScreen, 23 - Quotescreen, 24 - QuoteArchivescreen, 25 - Approvalscreen, 26 - CustomEntityscreen, 27 - AccountArchivescreen, 28 - ContactArchivescreen, 29 - FeedDetailScreen, 30 - BetterNavigatorscreen, 31 - FeedEmailscreen, 32 - FeedEmailDetailScreen, 33 - EmailScreen
    - `entity_api_name` string — API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty.
    - `name` string, required — Name of the entity and its default text representation.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `settings` object, required — Layout and chart configuration of the screen profile, stored as a JSON document.
    - `share_mode` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `sync_enabled` boolean — When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records.
    - `sync_entity_id` string, uuid — Id of the synchronized record.
    - `type` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Dynamic, 2 - Static
    - `use_lang` boolean — When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
    - `revision` integer — Revision when entity was lastly changed.
    - `pipelines` string[], required — For pipeline-screen profiles, ids of the pipelines included in the profile configuration; empty for profiles on other screens.

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