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

# Profiles.get

`GET /entities/Profiles/{id}`

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

Returns the Profile record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The Profile record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Profile: Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.
    - `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.
    - `owner` string, uri, required: User who owns the screen profile. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `sync_entity` string, uri: Specific record this profile is synchronized to. Set only when sync_enabled is true. Related Report record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Report' for its fields.
    - `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: Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entity_api_name identifies the custom entity. 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. This payload conforms to the `ProfileSettings` JSON Schema (see the linked schema).
    - `share_mode` 0 | 1 | 2 | 3: Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users. 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: Whether the profile lists the records matching its filter (Dynamic) or a fixed list of records added to it explicitly (Static). 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

- `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).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `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)