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

# entities.cloudObjectFolder

Read cloud object folder records with the cloudObjectFolder repository, and change them with the cloud object folder mutations. Same records as the REST CloudObjectFolders entity.

REST: [CloudObjectFolders](https://developers.coevera.com/reference/rest/cloud-object-folders.md).

## Queries

- `getById(entityId: ID!): CloudObjectFolderEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [CloudObjectFolderEntity!]!` 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: CloudObjectFolderFilterInput, orderBy: [CloudObjectFolderOrderByInput!], includeDeleted: Boolean): [CloudObjectFolderEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: CloudObjectFolderFilterInput, orderBy: [CloudObjectFolderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): CloudObjectFolderEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

## Mutations

- `createCloudObjectFolder(input: CreateCloudObjectFolderInput!, validationLevel: [ValidationLevel!]): CreateCloudObjectFolderPayload` Create one record.
- `updateCloudObjectFolder(input: UpdateCloudObjectFolderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateCloudObjectFolderPayload` Update fields.
- `bulkUpdateCloudObjectFolder(input: [CreateOrUpdateCloudObjectFolderInput!]!, deleteInput: [DeleteCloudObjectFolderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateCloudObjectFolderPayload` Create or update many; per-item results.
- `deleteCloudObjectFolder(input: DeleteCloudObjectFolderInput!, deleteContents: Boolean): DeleteCloudObjectFolderPayload` Soft-delete.

## Types

### CloudObjectFolderEntity (object)

Folder that organizes files, either in the company documents or within a record.

- `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.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `onlineFormType: OnlineFormTypeEntity` Online form template this folder is associated with, when the folder stores form submissions.
- `parentCloudObjectFolder: CloudObjectFolderEntity` Parent folder, when this folder is nested. Empty for top-level folders.
- `entityApiName: String` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `entityType: BaseEntityTypeEnum` Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
- `name: String!` Name of the entity and its default text representation.
- `onlineFormTypeId: ID` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: ID` Id of the parent folder, or empty for top-level folders.
- `revision: Int` Revision when entity was lastly changed.
- `type: CloudObjectFolderType!` Folder kind: Company for shared company folders, Record for folders attached to a specific record.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### CloudObjectFolderEntityConnection (object)

Paginated list of CloudObjectFolder records.

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

### CloudObjectFolderEntityEdge (object)

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

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

### CloudObjectFolderFilterInput (input)

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

- `OR: [CloudObjectFolderFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [CloudObjectFolderFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: CloudObjectFolderFilterInput` 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: EntityFilterStringField` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `entityType: BaseEntityTypeEnumFilterInput` Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `onlineFormTypeId: EntityFilterStringField` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: EntityFilterStringField` Id of the parent folder, or empty for top-level folders.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `type: CloudObjectFolderType` Folder kind: Company for shared company folders, Record for folders attached to a specific record.
- `onlineFormType: OnlineFormTypeFilterInput` Online form template this folder is associated with, when the folder stores form submissions. Matches records where a related record meets these conditions.
- `parentCloudObjectFolder: CloudObjectFolderFilterInput` Parent folder, when this folder is nested. Empty for top-level folders. Matches records where a related record meets these conditions.

### CloudObjectFolderOrderByInput (input)

Sorting of CloudObjectFolder 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.
- `onlineFormType: [OnlineFormTypeOrderByNestedInput!]` Online form template this folder is associated with, when the folder stores form submissions. Sorts by fields of the related record, listed in order of priority.
- `parentCloudObjectFolder: [CloudObjectFolderOrderByNestedInput!]` Parent folder, when this folder is nested. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority.
- `entityApiName: OrderByEnum` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `onlineFormTypeId: OrderByEnum` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: OrderByEnum` Id of the parent folder, or empty for top-level folders.
- `revision: OrderByEnum` Revision when entity was lastly changed.
- `type: OrderByEnum` Folder kind: Company for shared company folders, Record for folders attached to a specific record.

### CreateCloudObjectFolderInput (input)

Field values of a new CloudObjectFolder record.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `entityApiName: String` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `entityType: BaseEntityTypeEnum` Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
- `name: String!` Name of the entity and its default text representation.
- `onlineFormTypeId: ID` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: ID` Id of the parent folder, or empty for top-level folders.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateCloudObjectFolderInput (input)

Field values of a CloudObjectFolder record to create, or to update when its id is set.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `entityApiName: String` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `entityType: BaseEntityTypeEnum` Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
- `name: String` Name of the entity and its default text representation.
- `onlineFormTypeId: ID` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: ID` Id of the parent folder, or empty for top-level folders.
- `revision: Int` Revision when entity was lastly changed.

### DeleteCloudObjectFolderInput (input)

Id of the CloudObjectFolder record to delete.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.

### UpdateCloudObjectFolderInput (input)

Id of a CloudObjectFolder record and the field values to change.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `entityApiName: String` API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
- `name: String` Name of the entity and its default text representation.
- `onlineFormTypeId: ID` Id of the online form template, or empty when not associated with a form.
- `parentCloudObjectFolderId: ID` Id of the parent folder, or empty for top-level folders.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateCloudObjectFolderPayload (object)

Result of the bulkUpdateCloudObjectFolder mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateCloudObjectFolderPayload (object)

Result of the createCloudObjectFolder mutation.

- `cloudObjectFolder: CloudObjectFolderEntity` The created record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### DeleteCloudObjectFolderPayload (object)

Result of the deleteCloudObjectFolder mutation.

- `errors: Boolean!` The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
- `cloudObjectFolder: CloudObjectFolderEntity!` The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### UpdateCloudObjectFolderPayload (object)

Result of the updateCloudObjectFolder mutation.

- `cloudObjectFolder: CloudObjectFolderEntity` The updated record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### CloudObjectFolderType (enum)

Kind of document folder.

- `Company` Shared company folder, not tied to a record.
- `Record` Folder attached to a specific record.

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