---
title: entities.customEntityType
description: Read custom entity type records with the customEntityType repository, and change them with the custom entity type mutations. Same records as the REST {custom_entity_type_api_name} entity.
canonical: https://developers.coevera.com/reference/graphql/custom-entity-type/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.customEntityType

Read custom entity type records with the customEntityType repository, and change them with the custom entity type mutations. Same records as the REST {custom_entity_type_api_name} entity.

REST: [{custom_entity_type_api_name}](https://developers.coevera.com/reference/rest/custom-entity-types.md).

## Queries

- `getById(entityId: ID!): CustomEntityTypeEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [CustomEntityTypeEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: CustomEntityTypeFilterInput, orderBy: [CustomEntityTypeOrderByInput!], includeDeleted: Boolean): [CustomEntityTypeEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: CustomEntityTypeFilterInput, orderBy: [CustomEntityTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): CustomEntityTypeEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getPublished(limit: Int, offset: Int, filter: CustomEntityTypeFilterInput, orderBy: [CustomEntityTypeOrderByInput!], includeDeleted: Boolean): [CustomEntityTypeEntity!]!` Returns the published records that match the filter, paged with limit and offset.
- `getDrafts(filter: CustomEntityTypeFilterInput, orderBy: [CustomEntityTypeOrderByInput!]): [CustomEntityTypeEntity!]!` Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
- `getDraftById(entityId: ID!): CustomEntityTypeEntity!` Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

## Types

### CustomEntityTypeEntity (object)

Configurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity.

- `hasDraft: Boolean` True when the record has unpublished draft changes, including pending translation changes, that can be published.
- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `formEditApi: Form` Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost).
- `canChangeReadonly: Boolean` False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `formEdit: JSONString!` JSON definition of the form layout used by the UI when creating or editing records of this custom entity type.
- `isReadonly: Boolean!` True when the custom entity type is system-managed and cannot be edited or deleted by users.
- `name: String!` Name of the entity and its default text representation.
- `settings: EntityTypeSettings!` Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type.
- `isPublished: Boolean` True when the entity configuration is published; false while it exists only as an unpublished draft.
- `entityApiName: String` API name of the custom entity type (e.g. "Vehicle", "Project_Phase"). Used as the entity name when calling REST endpoints or selecting a concrete custom entity in GraphQL.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### CustomEntityTypeEntityConnection (object)

Paginated list of CustomEntityType records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [CustomEntityTypeEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### CustomEntityTypeEntityEdge (object)

A Relay edge containing a `CustomEntityTypeEntity` and its cursor.

- `node: CustomEntityTypeEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### CustomEntityTypeFilterInput (input)

Filter conditions for CustomEntityType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [CustomEntityTypeFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [CustomEntityTypeFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: CustomEntityTypeFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `isReadonly: Boolean` True when the custom entity type is system-managed and cannot be edited or deleted by users.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `isPublished: Boolean` True when the entity configuration is published; false while it exists only as an unpublished draft.

### CustomEntityTypeOrderByInput (input)

Sorting of CustomEntityType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `isReadonly: OrderByEnum` True when the custom entity type is system-managed and cannot be edited or deleted by users.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `isPublished: OrderByEnum` True when the entity configuration is published; false while it exists only as an unpublished draft.

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstCustomEntityTypes {
  entities {
    customEntityType {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCustomEntityTypes { entities { customEntityType { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'
```