Developers
ChangelogSupportcoevera.comGet API keys
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

REST APIFields and custom entitiesCustom entity types

Custom entity types

View as Markdown/reference/rest/custom-entity-types.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

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

The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.

MethodPathOperation
GET/entities/{custom_entity_type_api_name}CustomEntityTypes.list
POST/entities/{custom_entity_type_api_name}CustomEntityTypes.create
GET/entities/{custom_entity_type_api_name}/{id}CustomEntityTypes.get
PATCH/entities/{custom_entity_type_api_name}/{id}CustomEntityTypes.update
DEL/entities/{custom_entity_type_api_name}/{id}CustomEntityTypes.delete
POST/entities/{custom_entity_type_api_name}/batch-modifyCustomEntityTypes.batch_create_or_update
POST/entities/{custom_entity_type_api_name}/batch-deleteCustomEntityTypes.batch_delete
POST/entities/{custom_entity_type_api_name}/batch-restoreCustomEntityTypes.batch_restore

GET CustomEntityTypes.list

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

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required

Query parameters

NameTypeDescription
include-deletedbooleanInclude soft-deleted records. Lists only; get-by-id refuses it.
firstintegerPage size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
lastintegerReturn the last N records of the result; together with first, the last N of the first M. Maximum 100.
beforestringCursor from page_info.start_cursor, to page backwards. URL-encode it.
afterstringCursor from page_info.end_cursor of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
expandstringRelated records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in account_relations.account.
order-bystringFields to sort by, comma-separated. A leading - sorts descending, as in -modified; dotted paths sort by related fields.
filterobjectfilter[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-opobjectfilter-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-onlystringFields 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 CustomEntityType records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

GET /entities/{custom_entity_type_api_name}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST CustomEntityTypes.create

Creates a CustomEntityType record.

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required

Query parameters

NameTypeDescription
validation-levelintegerBit 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 createCustomEntityTypeInput; the fields are in CustomEntityType fields. Required: form_edit, is_readonly, name, settings.

Responses

201 The created CustomEntityType record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/{custom_entity_type_api_name}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "form_edit": {},
  "is_readonly": false,
  "name": "Northwind custom entity type",
  "settings": "Northwind settings"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    form_edit: {},
    is_readonly: false,
    name: 'Northwind custom entity type',
    settings: 'Northwind settings'
  })
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "form_edit": {},
      "is_readonly": False,
      "name": "Northwind custom entity type",
      "settings": "Northwind settings"
    }
)

GET CustomEntityTypes.get

Returns the CustomEntityType record with the given id.

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required
idstring (uuid)Id of the CustomEntityType record to retrieve. Required

Query parameters

NameTypeDescription
expandstringRelated records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The CustomEntityType record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

GET /entities/{custom_entity_type_api_name}/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH CustomEntityTypes.update

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

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required
idstring (uuid)Id of the CustomEntityType record to update. Required

Query parameters

NameTypeDescription
validation-levelintegerBit 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 updateCustomEntityTypeInput; the fields are in CustomEntityType fields.

Responses

200 The changed CustomEntityType record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

PATCH /entities/{custom_entity_type_api_name}/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind custom entity type (renamed)"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind custom entity type (renamed)'
  })
})
import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind custom entity type (renamed)"
    }
)

DEL CustomEntityTypes.delete

Deletes the CustomEntityType record with the given id.

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required
idstring (uuid)Id of the CustomEntityType record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

DEL /entities/{custom_entity_type_api_name}/{id}
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})
import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/7a000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST CustomEntityTypes.batch_create_or_update

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

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required

Query parameters

NameTypeDescription
validation-levelintegerBit 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-methodinteger0, 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.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchCustomEntityTypeInput; the fields are in CustomEntityType fields. Required: form_edit, is_readonly, name, settings.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/{custom_entity_type_api_name}/batch-modify
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "form_edit": {},
    "is_readonly": false,
    "name": "Northwind custom entity type",
    "settings": "Northwind settings"
  },
  {
    "id": "7a000000-0000-4000-a000-000000000001",
    "name": "Northwind custom entity type (renamed)"
  }
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      form_edit: {},
      is_readonly: false,
      name: 'Northwind custom entity type',
      settings: 'Northwind settings'
    },
    {
      id: '7a000000-0000-4000-a000-000000000001',
      name: 'Northwind custom entity type (renamed)'
    }
  ])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "form_edit": {},
        "is_readonly": False,
        "name": "Northwind custom entity type",
        "settings": "Northwind settings"
      },
      {
        "id": "7a000000-0000-4000-a000-000000000001",
        "name": "Northwind custom entity type (renamed)"
      }
    ]
)

POST CustomEntityTypes.batch_delete

Deletes the CustomEntityType records with the given ids.

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required

Query parameters

NameTypeDescription
rollback-methodinteger0, 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.

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 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

POST /entities/{custom_entity_type_api_name}/batch-delete
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "7a000000-0000-4000-a000-000000000001",
  "7a000000-0000-4000-a000-000000000002"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['7a000000-0000-4000-a000-000000000001', '7a000000-0000-4000-a000-000000000002'])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "7a000000-0000-4000-a000-000000000001",
      "7a000000-0000-4000-a000-000000000002"
    ]
)

POST CustomEntityTypes.batch_restore

Restores the deleted CustomEntityType records with the given ids.

Path parameters

NameTypeDescription
custom_entity_type_api_namestringAPI name of the custom entity whose record types to work with. Required

Query parameters

NameTypeDescription
rollback-methodinteger0, 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.

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 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

POST /entities/{custom_entity_type_api_name}/batch-restore
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "7a000000-0000-4000-a000-000000000001",
  "7a000000-0000-4000-a000-000000000002"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['7a000000-0000-4000-a000-000000000001', '7a000000-0000-4000-a000-000000000002'])
})
import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_AssetType/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "7a000000-0000-4000-a000-000000000001",
      "7a000000-0000-4000-a000-000000000002"
    ]
)

CustomEntityType fields

FieldTypeNotes
iduuidRead-only Unique identifier of entity.
form_editobjectRequired on create JSON definition of the form layout used by the UI when creating or editing records of this custom entity type.
is_readonlybooleanRequired on create True when the custom entity type is system-managed and cannot be edited or deleted by users.
namestringRequired on create Name of the entity and its default text representation.
settingsbinaryRequired on create Per-type configuration for records of this entity type, e.g.
has_draftbooleanRead-only True when the record has unpublished draft changes, including pending translation changes, that can be published.
is_delete_protectedbooleanRead-only True when the record is protected against deletion because it must always exist in the space.
form_edit_apiobjectRead-only Typed, read-only view of a form layout of this type: form_edit_api mirrors the edit form (form_edit), form_lost_api the form shown when archiving as lost …
can_change_readonlybooleanRead-only False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise.
is_deletedbooleanRead-only Specifies if the entity is considered deleted.
modifieddate-timeRead-only Last modification time.
createddate-timeRead-only Creation time.
is_publishedbooleanRead-only True when the entity configuration is published; false while it exists only as an unpublished draft.
entity_api_namestringRead-only API name of the custom entity type (e.g.

Custom fields appear in your space's live spec: fetch it 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. All codes: error codes; how to handle them: Errors.

HTTPWhen
400Bad 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.
401Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422Validation 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.
429Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500Unexpected server error (code 1000, ERROR_UNKNOWN).