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

# entities.entitySettings

Read entity settings records with the entitySettings repository, and change them with the entity settings mutations. Same records as the REST EntitySettingses entity.

REST: [EntitySettingses](https://developers.coevera.com/reference/rest/entity-settingses.md).

## Queries

- `getById(entityId: ID!): EntitySettingsEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [EntitySettingsEntity!]!` 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: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean): [EntitySettingsEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean): [EntitySettingsEntity!]!` Returns the records that match the filter as a cursor-paginated connection.
- `getPublished(limit: Int, offset: Int, filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!], includeDeleted: Boolean): [EntitySettingsEntity!]!` Returns the published records that match the filter, paged with limit and offset.
- `getDrafts(filter: EntitySettingsFilterInput, orderBy: [EntitySettingsOrderByInput!]): [EntitySettingsEntity!]!` Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
- `getDraftById(entityId: ID!): EntitySettingsEntity!` Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
- `getForEntity(entity: EntityNameEnum!, entityApiName: String): EntitySettingsEntity` Returns the settings of the given record type (e.g. list and detail layout options).

## Types

### EntitySettingsEntity (object)

Space-wide settings of an entity, such as the default columns of its lists.

- `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.
- `hasDraft: Boolean` True when the record has unpublished draft changes, including pending translation changes, that can be published.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `defaultListColumns: EntitySettingsDefaultListColumns!` Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users).
- `entityApiName: String` For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
- `isPublished: Boolean` True when the settings are published; false while they exist only as an unpublished draft.
- `revision: Int` Revision when entity was lastly changed.
- `entityName: EntityNameEnum!` Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### EntitySettingsFilterInput (input)

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

- `OR: [EntitySettingsFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [EntitySettingsFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: EntitySettingsFilterInput` 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.
- `entityApiName: String` For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
- `isPublished: Boolean` True when the settings are published; false while they exist only as an unpublished draft.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `entityName: EntityNameEnum` Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).

### EntitySettingsOrderByInput (input)

Sorting of EntitySettings 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.
- `entityApiName: OrderByEnum` For custom entities, the concrete API name of the entity these settings apply to. Empty for built-in entities (where entityName already identifies them).
- `isPublished: OrderByEnum` True when the settings are published; false while they exist only as an unpublished draft.
- `revision: OrderByEnum` Revision when entity was lastly changed.
- `entityName: OrderByEnum` Name of the entity these settings apply to. For custom entities resolves to the literal "CustomEntity" (see entityApiName for the concrete API name).

### EntityListColumn (object)

Column of a record list: the field shown, its relative width and whether it is frozen.

- `fieldId: String!` Id of the field shown in the column.
- `width: Float!` Relative width of the column.
- `frozen: Boolean!` When true, the column is pinned to the left edge and stays visible while the list scrolls horizontally.

### EntitySettingsDefaultListColumns (object)

Default column layout of the record list of an entity, optionally applied to existing users.

- `applyToExistingUsers: Boolean!` When true, publishing the settings resets the column layout of existing users to these defaults; the flag is then cleared.
- `columns: [EntityListColumn!]!` Default columns of the list, in display order.

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 FirstEntitySettingss {
  entities {
    entitySettings {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id 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 FirstEntitySettingss { entities { entitySettings { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```