---
title: InterfacePreviews
description: "InterfacePreviews: list, get, create, update and delete, plus batch operations."
canonical: https://developers.coevera.com/reference/rest/interface-previews/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# InterfacePreviews

InterfacePreviews: list, get, create, update and delete, plus batch operations.

Family: Fields and custom entities. GraphQL: [interfacePreview](https://developers.coevera.com/reference/graphql/interface-preview.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/InterfacePreviews` | List InterfacePreviews |
| POST | `/entities/InterfacePreviews` | Create InterfacePreview |
| GET | `/entities/InterfacePreviews/{id}` | Get InterfacePreview |
| PATCH | `/entities/InterfacePreviews/{id}` | Update InterfacePreview |
| DELETE | `/entities/InterfacePreviews/{id}` | Delete InterfacePreview |
| POST | `/entities/InterfacePreviews/batch-modify` | Create or update InterfacePreviews in a batch |
| POST | `/entities/InterfacePreviews/batch-delete` | Delete InterfacePreviews in a batch |
| POST | `/entities/InterfacePreviews/batch-restore` | Restore deleted InterfacePreviews |

## List InterfacePreviews

`GET /entities/InterfacePreviews`

Returns the InterfacePreviews the API application can read, one page at a time. In the list envelope, `total` counts every match and `page_info` pages through them.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | object | `filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
| `filter-op` | query | object | `filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
| `load-only` | query | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |

Responses: 200 (Page of InterfacePreview records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews?first=10' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create InterfacePreview

`POST /entities/InterfacePreviews`

Creates one record and answers 201 with it.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The new record's fields. Relations are set by id. Schema `createInterfacePreviewInput`. Required: `card_field_ids`, `charts`, `detail_tabs`, `detail_widgets`, `field_ids`, `settings`, `entity_type_id`.

Responses: 201 (The created InterfacePreview record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "card_field_ids": {},
  "charts": {},
  "detail_tabs": {},
  "detail_widgets": {},
  "field_ids": {},
  "settings": "Northwind settings",
  "entity_type_id": "d5000000-0000-4000-a000-000000000001"
}'
```

## Get InterfacePreview

`GET /entities/InterfacePreviews/{id}`

Returns one record by id. `expand` returns related records inline instead of their URIs.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the InterfacePreview record to retrieve. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |

Responses: 200 (The InterfacePreview record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/a5000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Update InterfacePreview

`PATCH /entities/InterfacePreviews/{id}`

Changes the fields you send and leaves the rest as they are; there is no PUT.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the InterfacePreview record to update. |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The fields to change. Schema `updateInterfacePreviewInput`.

Responses: 200 (The changed InterfacePreview record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/a5000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "card_field_ids": {}
}'
```

## Delete InterfacePreview

`DELETE /entities/InterfacePreviews/{id}`

Deletes one record and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the InterfacePreview record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/a5000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create or update InterfacePreviews in a batch

`POST /entities/InterfacePreviews/batch-modify`

An item with an `id` updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with `rollback-method=1` the response has an id or an error for each item, in input order.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchInterfacePreviewInput`. Required: `card_field_ids`, `charts`, `detail_tabs`, `detail_widgets`, `field_ids`, `settings`, `entity_type_id`.

Responses: 200 (Result per item, in request order: the id of the created or updated record, or the error.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "card_field_ids": {},
    "charts": {},
    "detail_tabs": {},
    "detail_widgets": {},
    "field_ids": {},
    "settings": "Northwind settings",
    "entity_type_id": "d5000000-0000-4000-a000-000000000001"
  },
  {
    "id": "a5000000-0000-4000-a000-000000000001",
    "card_field_ids": {}
  }
]'
```

## Delete InterfacePreviews in a batch

`POST /entities/InterfacePreviews/batch-delete`

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the deleted record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "a5000000-0000-4000-a000-000000000001",
  "a5000000-0000-4000-a000-000000000002"
]'
```

## Restore deleted InterfacePreviews

`POST /entities/InterfacePreviews/batch-restore`

Restores the deleted records whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the restored record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/InterfacePreviews/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "a5000000-0000-4000-a000-000000000001",
  "a5000000-0000-4000-a000-000000000002"
]'
```

## InterfacePreview fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `card_field_ids` | object | Required on create. Ordered ids of fields shown on the record's compact card view. |
| `charts` | object | Required on create. Chart configurations shown in the preview, each linked to a related entity (e.g. |
| `detail_tabs` | object | Required on create. Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs). |
| `detail_widgets` | object | Required on create. Widget configurations shown on the record's detail screen sidebar (e.g. |
| `field_ids` | object | Required on create. Ordered ids of fields shown in the record's preview pane. |
| `settings` | binary | Required on create. Layout-customization settings for the preview (e.g. |
| `entity_type_id` | uuid | Required on create. Read-only. Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set. |
| `revision` | integer | Revision when entity was lastly changed. |
| `is_delete_protected` | boolean | Read-only. True when the record is protected against deletion because it must always exist in the space. |
| `has_draft` | boolean | Read-only. True when the record has unpublished draft changes, including pending translation changes, that can be published. |
| `is_deleted` | boolean | Read-only. Specifies if the entity is considered deleted. |
| `modified` | date-time | Read-only. Last modification time. |
| `created` | date-time | Read-only. Creation time. |
| `account_type` | uri → AccountTypes | Read-only. Account type the interface preview applies to. |
| `appointment_type` | uri → AppointmentTypes | Read-only. Appointment type the interface preview applies to. |
| `contact_type` | uri → ContactTypes | Read-only. Contact type the interface preview applies to. |
| `custom_entity_type` | uri | Read-only. Custom entity type the interface preview applies to. |
| `lead_type` | uri → LeadTypes | Read-only. Lead type the interface preview applies to. |
| `oppty_type` | uri → OpportunityTypes | Read-only. Opportunity type the interface preview applies to. |
| `product_type` | uri → ProductTypes | Read-only. Product type the interface preview applies to. |
| `project_type` | uri → ProjectTypes | Read-only. Project type the interface preview applies to. |
| `quote_type` | uri → QuoteTypes | Read-only. Quote type the interface preview applies to. |
| `task_type` | uri → TaskTypes | Read-only. Task type the interface preview applies to. |
| `account_type_id` | uuid → AccountTypes | Read-only. Id of the account type the interface preview applies to. |
| `appointment_type_id` | uuid → AppointmentTypes | Read-only. Id of the appointment type the interface preview applies to. |
| `contact_type_id` | uuid → ContactTypes | Read-only. Id of the contact type the interface preview applies to. |
| `custom_entity_type_id` | uuid | Read-only. Id of the custom entity type the interface preview applies to. |
| `lead_type_id` | uuid → LeadTypes | Read-only. Id of the lead type the interface preview applies to. |
| `oppty_type_id` | uuid → OpportunityTypes | Read-only. Id of the opportunity type. |
| `product_type_id` | uuid → ProductTypes | Read-only. Id of the product type the interface preview applies to. |
| `project_type_id` | uuid → ProjectTypes | Read-only. Id of the project type the interface preview applies to. |
| `quote_type_id` | uuid → QuoteTypes | Read-only. Id of the quote type the interface preview applies to. |
| `task_type_id` | uuid → TaskTypes | Read-only. Id of the task type the interface preview applies to. |
| `is_published` | boolean | Read-only. True when the interface preview is published; false while it exists only as an unpublished draft. |
| `entity_type` | integer | Read-only. Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Values: 1 Lead, 2 Account, 3 Contact, 4 Opportunity, 5 Task, 6 Appointment, 7 OpptyProductRelation, 8 Project, 9 Quote, 10 OnlineForm, 11 CustomEntity, 12 Product. |

Custom fields appear in your space's live spec: `GET /api/v100/rest/spaces/{space_id}/openapi.json` with your credentials.

## Errors

Every error body has `success: false`, `http_status`, `code`, `name` and `message`. Branch on `code`: the status alone does not tell a missing permission from a bad parameter.

| HTTP | When |
| --- | --- |
| 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). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md