--- title: "InterfacePreviews.get" method: GET path: "/entities/InterfacePreviews/{id}" tags: ["Interface"] --- # InterfacePreviews.get `GET /entities/InterfacePreviews/{id}` Returns InterfacePreview with given id ## Path parameters - `id` string, uuid, required ## Response `200` InterfacePreview data - object - `success` boolean — True when response succeeded, false on error. - `data` InterfacePreview - `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. - `has_draft` boolean, required — Set to True if draft for entity exists and can be published - `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. - `account_type` string, uri — Account type the interface preview applies to. Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties. - `appointment_type` string, uri — Appointment type the interface preview applies to. Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. - `contact_type` string, uri — Contact type the interface preview applies to. Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties. - `custom_entity_type` string, uri — Custom entity type the interface preview applies to. 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. - `lead_type` string, uri — Lead type the interface preview applies to. Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. - `oppty_type` string, uri — Opportunity type the interface preview applies to. Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties. - `product_type` string, uri — Product type the interface preview applies to. Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties. - `project_type` string, uri — Project type the interface preview applies to. Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties. - `quote_type` string, uri — Quote type the interface preview applies to. Relation to QuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'QuoteType' object for properties. - `task_type` string, uri — Task type the interface preview applies to. Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. - `account_type_id` string, uuid — Id of the account type. - `appointment_type_id` string, uuid — Id of the appointment type. - `card_field_ids` object, required — Ordered ids of fields shown on the record's compact card view. - `charts` object, required — Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments). - `contact_type_id` string, uuid — Id of the contact type. - `custom_entity_type_id` string, uuid — Id of the custom entity type. - `detail_tabs` object, required — Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs). - `detail_widgets` object, required — Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs). - `field_ids` object, required — Ordered ids of fields shown in the record's preview pane. - `lead_type_id` string, uuid — Id of the lead type. - `oppty_type_id` string, uuid — Id of the opportunity type. - `product_type_id` string, uuid — Id of the product type. - `project_type_id` string, uuid — Id of the project type. - `quote_type_id` string, uuid — Id of the quote type. - `settings` string, binary, required — Layout-customization settings for the preview (e.g. is_layout_customization_enabled). - `task_type_id` string, uuid — Id of the task type. - `is_published` boolean — True when the interface preview is published; false while it exists only as an unpublished draft. - `revision` integer — Revision when entity was lastly changed. - `entity_type_id` string, uuid, required — Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set. - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required — Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product ## 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)