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

# Custom entity records

Custom entity records: list, get, create, update and delete, plus batch operations.

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

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/{custom_entity_api_name}` | CustomEntities.list |
| POST | `/entities/{custom_entity_api_name}` | CustomEntities.create |
| GET | `/entities/{custom_entity_api_name}/{id}` | CustomEntities.get |
| PATCH | `/entities/{custom_entity_api_name}/{id}` | CustomEntities.update |
| DELETE | `/entities/{custom_entity_api_name}/{id}` | CustomEntities.delete |
| POST | `/entities/{custom_entity_api_name}/batch-modify` | CustomEntities.batch_create_or_update |
| POST | `/entities/{custom_entity_api_name}/batch-delete` | CustomEntities.batch_delete |
| POST | `/entities/{custom_entity_api_name}/batch-restore` | CustomEntities.batch_restore |

## CustomEntities.list

`GET /entities/{custom_entity_api_name}`

Returns a page of CustomEntity records, optionally filtered, sorted and limited to selected fields.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `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 CustomEntity records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## CustomEntities.create

`POST /entities/{custom_entity_api_name}`

Creates a CustomEntity record.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `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 `createCustomEntityInput`. Required: `owner_id`.

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

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

## CustomEntities.get

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

Returns the CustomEntity record with the given id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `id` | path | string (uuid) | Required. Id of the CustomEntity 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 CustomEntity record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## CustomEntities.update

`PATCH /entities/{custom_entity_api_name}/{id}`

Changes fields of the CustomEntity record with the given id; fields left out keep their values.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `id` | path | string (uuid) | Required. Id of the CustomEntity 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 `updateCustomEntityInput`.

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

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind custom entity (renamed)"
}'
```

## CustomEntities.delete

`DELETE /entities/{custom_entity_api_name}/{id}`

Deletes the CustomEntity record with the given id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `id` | path | string (uuid) | Required. Id of the CustomEntity 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/CE_Asset/9a000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## CustomEntities.batch_create_or_update

`POST /entities/{custom_entity_api_name}/batch-modify`

Creates or updates CustomEntity records in one request: an item with an id updates that record, an item without one creates a new record.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `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 `batchCustomEntityInput`. Required: `owner_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/CE_Asset/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "owner_id": "37000000-0000-4000-a000-000000000001"
  },
  {
    "id": "9a000000-0000-4000-a000-000000000001",
    "name": "Northwind custom entity (renamed)"
  }
]'
```

## CustomEntities.batch_delete

`POST /entities/{custom_entity_api_name}/batch-delete`

Deletes the CustomEntity records with the given ids.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `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/CE_Asset/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "9a000000-0000-4000-a000-000000000001",
  "9a000000-0000-4000-a000-000000000002"
]'
```

## CustomEntities.batch_restore

`POST /entities/{custom_entity_api_name}/batch-restore`

Restores the deleted CustomEntity records with the given ids.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `custom_entity_api_name` | path | string | Required. API name of the custom entity whose records to work with. |
| `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/CE_Asset/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "9a000000-0000-4000-a000-000000000001",
  "9a000000-0000-4000-a000-000000000002"
]'
```

## CustomEntity fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `owner_id` | uuid → Clients | Required on create. Id of the sales user who owns the custom entity record. |
| `currency_exchange_rates_list_id` | uuid → CurrencyExchangeRatesLists | Id of the currency exchange rate list applied to this record. |
| `name` | string | Name of the entity and its default text representation. |
| `share_mode` | integer | Sharing model applied on top of the owner/unit visibility (e.g. Values: 0 Standard, 1 Private, 2 AllView, 3 AllEdit. |
| `type_id` | uuid | Id of the custom entity type. |
| `unit_id` | uuid → SalesUnits | Id of the sales unit. |
| `sharing_units` | array of uri | Sales units that have been granted shared access to this custom entity record. |
| `sharing_clients` | array of uri | Users that have been granted shared access to this custom entity record. |
| `documents` | array of uri → CloudObjectRelations | Documents linked to this custom entity record. |
| `static_profiles` | array of uri → ProfileRelations | Saved view profiles this custom entity record currently matches. |
| `tags` | array of uri → TagRelations | Tag labels applied to this custom entity record. |
| `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. |
| `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. |
| `currency_exchange_rates_list` | uri → CurrencyExchangeRatesLists | Read-only. Currency exchange rate list used to convert monetary fields linked to this record. |
| `owner` | uri → Clients | Read-only. Sales user who owns this custom entity record. |
| `type` | uri | Read-only. Custom entity type that classifies this record. |
| `unit` | uri → SalesUnits | Read-only. Sales unit this record is assigned to. |
| `table_name` | string | Read-only. Discriminator identifying which custom entity type this record belongs to. |
| `is_favorite` | boolean | Read-only. True when the current authenticated user has marked this record as favorite. |

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

## Webhook events for custom entity records

`CustomEntity.Create`, `CustomEntity.Delete`, `CustomEntity.DocumentLinked`, `CustomEntity.OwnerChanged`, `CustomEntity.Update`. Payloads: https://developers.coevera.com/webhooks/events.md

Subscribe with [Create a webhook](https://developers.coevera.com/reference/rest/webhooks.md).