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 records

Custom entity records

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

Custom entity records: 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_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
DEL/entities/{custom_entity_api_name}/{id}CustomEntities.delete
POST/entities/{custom_entity_api_name}/batch-modifyCustomEntities.batch_create_or_update
POST/entities/{custom_entity_api_name}/batch-deleteCustomEntities.batch_delete
POST/entities/{custom_entity_api_name}/batch-restoreCustomEntities.batch_restore

GET CustomEntities.list

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

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records 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 CustomEntity records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

GET /entities/{custom_entity_api_name}
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"
fetch('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', {
  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_Asset",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST CustomEntities.create

Creates a CustomEntity record.

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records 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 createCustomEntityInput; the fields are in CustomEntity fields. Required: owner_id.

Responses

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

POST /entities/{custom_entity_api_name}
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"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    owner_id: '37000000-0000-4000-a000-000000000001'
  })
})
import os

import requests

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

GET CustomEntities.get

Returns the CustomEntity record with the given id.

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records to work with. Required
idstring (uuid)Id of the CustomEntity 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 CustomEntity record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

GET /entities/{custom_entity_api_name}/{id}
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"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-0000-4000-a000-000000000001?expand=owner', {
  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_Asset/9a000000-0000-4000-a000-000000000001",
    params={
      "expand": "owner"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH CustomEntities.update

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

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records to work with. Required
idstring (uuid)Id of the CustomEntity 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 updateCustomEntityInput; the fields are in CustomEntity fields.

Responses

200 The changed CustomEntity 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_api_name}/{id}
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)"
}'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-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 (renamed)'
  })
})
import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-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 (renamed)"
    }
)

DEL CustomEntities.delete

Deletes the CustomEntity record with the given id.

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records to work with. Required
idstring (uuid)Id of the CustomEntity 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_api_name}/{id}
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"
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/9a000000-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_Asset/9a000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST CustomEntities.batch_create_or_update

Creates or updates CustomEntity 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_api_namestringAPI name of the custom entity whose records 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 batchCustomEntityInput; the fields are in CustomEntity fields. 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 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

POST /entities/{custom_entity_api_name}/batch-modify
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)"
  }
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/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([
    {
      owner_id: '37000000-0000-4000-a000-000000000001'
    },
    {
      id: '9a000000-0000-4000-a000-000000000001',
      name: 'Northwind custom entity (renamed)'
    }
  ])
})
import os

import requests

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

POST CustomEntities.batch_delete

Deletes the CustomEntity records with the given ids.

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records 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_api_name}/batch-delete
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"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/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(['9a000000-0000-4000-a000-000000000001', '9a000000-0000-4000-a000-000000000002'])
})
import os

import requests

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

POST CustomEntities.batch_restore

Restores the deleted CustomEntity records with the given ids.

Path parameters

NameTypeDescription
custom_entity_api_namestringAPI name of the custom entity whose records 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_api_name}/batch-restore
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"
]'
fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/CE_Asset/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(['9a000000-0000-4000-a000-000000000001', '9a000000-0000-4000-a000-000000000002'])
})
import os

import requests

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

CustomEntity fields

FieldTypeNotes
iduuidRead-only Unique identifier of entity.
owner_iduuid → ClientsRequired on create Id of the sales user who owns the custom entity record.
currency_exchange_rates_list_iduuid → CurrencyExchangeRatesListsId of the currency exchange rate list applied to this record.
namestringName of the entity and its default text representation.
share_modeintegerSharing model applied on top of the owner/unit visibility (e.g.0 Standard · 1 Private · 2 AllView · 3 AllEdit
type_iduuidId of the custom entity type.
unit_iduuid → SalesUnitsId of the sales unit.
sharing_unitsarray of uriSales units that have been granted shared access to this custom entity record.
sharing_clientsarray of uriUsers that have been granted shared access to this custom entity record.
documentsarray of uri → CloudObjectRelationsDocuments linked to this custom entity record.
static_profilesarray of uri → ProfileRelationsSaved view profiles this custom entity record currently matches.
tagsarray of uri → TagRelationsTag labels applied to this custom entity record.
revisionintegerRevision when entity was lastly changed.
is_delete_protectedbooleanRead-only True when the record is protected against deletion because it must always exist in the space.
is_deletedbooleanRead-only Specifies if the entity is considered deleted.
Show all 23 fields
FieldTypeNotes
modifieddate-timeRead-only Last modification time.
createddate-timeRead-only Creation time.
currency_exchange_rates_listuri → CurrencyExchangeRatesListsRead-only Currency exchange rate list used to convert monetary fields linked to this record.
owneruri → ClientsRead-only Sales user who owns this custom entity record.
typeuriRead-only Custom entity type that classifies this record.
unituri → SalesUnitsRead-only Sales unit this record is assigned to.
table_namestringRead-only Discriminator identifying which custom entity type this record belongs to.
is_favoritebooleanRead-only True when the current authenticated user has marked this record as favorite.

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).

Webhook events for custom entity records

CustomEntity.Create CustomEntity.Delete CustomEntity.DocumentLinked CustomEntity.OwnerChanged CustomEntity.Update See payloads

Subscribe with Create a webhook.