--- title: entities.cloudObject description: Read cloud object records with the cloudObject repository, and change them with the cloud object mutations. Same records as the REST CloudObjects entity. canonical: https://developers.coevera.com/reference/graphql/cloud-object/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.cloudObject Read cloud object records with the cloudObject repository, and change them with the cloud object mutations. Same records as the REST CloudObjects entity. REST: [CloudObjects](https://developers.coevera.com/reference/rest/cloud-objects.md). ## Queries - `getById(entityId: ID!): CloudObjectEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [CloudObjectEntity!]!` 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: CloudObjectFilterInput, orderBy: [CloudObjectOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean): [CloudObjectEntity!]!` Returns the files that match the filter, paged with limit and offset. - `getByCriteria(filter: CloudObjectFilterInput, orderBy: [CloudObjectOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean, before: String, after: String, first: Int, last: Int): CloudObjectEntityConnection` Returns the files 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. - `getSignedUrls(urls: [String!]!, expireIn: Int): [SignedUrl!]!` Returns SignedUrl with public downloadable url link and their id. - `getDocumentPreviewUrl(entityId: UUID!): DocumentPreviewUrl!` Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why. - `getBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int): CloudObjectEntityConnection` Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. - `getByIdsForProcess(processId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that are attached to the process or to any email template. Ids of other files are ignored. - `getByIdsForEmailSequence(emailSequenceId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that are attached to the email sequence. Ids of files not attached to it are ignored. - `getByIdsForReportSchedule(reportScheduleId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that are attached to the report schedule. Ids of files not attached to it are ignored. - `getByIdsForApprovalProcess(approvalProcessId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that are attached to the approval process. Ids of files not attached to it are ignored. - `getByIdsForFieldMapping(fieldMappingId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that are attached to the field mapping. Ids of files not attached to it are ignored. - `getByIdsForOnlineFormType(onlineFormTypeId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]!` Returns those of the given files that were uploaded with a submission of the online form. Ids of other files are ignored. ## Mutations - `createCloudObject(input: CreateCloudObjectInput!, validationLevel: [ValidationLevel!]): CreateCloudObjectPayload` Create one record. - `updateCloudObject(input: UpdateCloudObjectInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateCloudObjectPayload` Update fields. - `bulkUpdateCloudObject(input: [CreateOrUpdateCloudObjectInput!]!, deleteInput: [DeleteCloudObjectInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateCloudObjectPayload` Create or update many; per-item results. - `deleteCloudObject(input: DeleteCloudObjectInput!): DeleteCloudObjectPayload` Soft-delete. - `createImageCloudObject(input: CreateImageInput!, validationLevel: [ValidationLevel!]): CreateImageCloudObjectPayload` Uploads an image and stores it as a new file in the space. GraphQL only. - `cloudObjectMakePublic(input: CloudObjectMakePublicInput!): CloudObjectMakePublicPayload` Makes the file publicly accessible and returns its public URL. Anyone with the URL can download the file without signing in. GraphQL only. - `moveCloudObjects(input: MoveCloudObjectsInput!): MoveCloudObjectsPayload` Move to another step. GraphQL only. - `deleteCloudObjects(input: DeleteCloudObjectsInput!): DeleteCloudObjectsPayload` Soft-delete. ## Types ### CloudObjectEntity (object) File stored in the space, such as a document, image or recording, that can be attached to records. - `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. - `application: ApplicationEntity` Application that produced the object (e.g. Online Forms). - `companyCloudObjectFolder: CloudObjectFolderEntity` Company-level folder that contains the object, when stored in the company document tree. - `creator: ClientEntity` User who uploaded the object. - `applicationId: ID` Id of the producing application. - `companyCloudObjectFolderId: ID` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: ID` Id of the uploading user. - `filename: String!` File name (with extension) used when downloading the object. - `isPublic: Boolean` When true, the object can be served via a public URL (see publicUrl). - `mimeType: String` Mime-type of the cloud object Is detected from content. - `params: JSONString` Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. - `size: Int!` Size of the object in bytes. - `type: CloudObjectTypeEnum!` Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. - `uploadSource: UploadSourceEnum` Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. - `url: String` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: Int` Revision when entity was lastly changed. - `dimensions: CloudObjectDimensions` Width and height of the image in pixels; empty for files that are not images. - `duration: Float` Duration of the audio recording in seconds; empty for other files. - `publicUrl: String` Publicly accessible link to the file; empty unless the file is marked as public. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### CloudObjectEntityConnection (object) Paginated list of CloudObject records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [CloudObjectEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### CloudObjectEntityEdge (object) A Relay edge containing a `CloudObjectEntity` and its cursor. - `node: CloudObjectEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### CloudObjectFilterInput (input) Filter conditions for CloudObject records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [CloudObjectFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [CloudObjectFilterInput!]` Matches records that meet all of the listed filters. - `NOT: CloudObjectFilterInput` 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. - `applicationId: EntityFilterStringField` Id of the producing application. - `companyCloudObjectFolderId: EntityFilterStringField` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: EntityFilterStringField` Id of the uploading user. - `filename: EntityFilterStringField` File name (with extension) used when downloading the object. - `isPublic: Boolean` When true, the object can be served via a public URL (see publicUrl). - `mimeType: EntityFilterStringField` Mime-type of the cloud object Is detected from content. - `size: EntityFilterNumberField` Size of the object in bytes. - `type: CloudObjectTypeEnumFilterInput` Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. - `uploadSource: UploadSourceEnumFilterInput` Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. - `url: EntityFilterStringField` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `application: ApplicationFilterInput` Application that produced the object (e.g. Online Forms). Matches records where a related record meets these conditions. - `companyCloudObjectFolder: CloudObjectFolderFilterInput` Company-level folder that contains the object, when stored in the company document tree. Matches records where a related record meets these conditions. - `creator: ClientFilterInput` User who uploaded the object. Matches records where a related record meets these conditions. ### CloudObjectOrderByInput (input) Sorting of CloudObject 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. - `application: [ApplicationOrderByNestedInput!]` Application that produced the object (e.g. Online Forms). Sorts by fields of the related record, listed in order of priority. - `companyCloudObjectFolder: [CloudObjectFolderOrderByNestedInput!]` Company-level folder that contains the object, when stored in the company document tree. Sorts by fields of the related record, listed in order of priority. - `creator: [ClientOrderByNestedInput!]` User who uploaded the object. Sorts by fields of the related record, listed in order of priority. - `applicationId: OrderByEnum` Id of the producing application. - `companyCloudObjectFolderId: OrderByEnum` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: OrderByEnum` Id of the uploading user. - `filename: OrderByEnum` File name (with extension) used when downloading the object. - `isPublic: OrderByEnum` When true, the object can be served via a public URL (see publicUrl). - `mimeType: OrderByEnum` Mime-type of the cloud object Is detected from content. - `size: OrderByEnum` Size of the object in bytes. - `url: OrderByEnum` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: OrderByEnum` Revision when entity was lastly changed. ### CloudObjectMakePublicInput (input) Parameters of the cloudObjectMakePublic mutation. - `entityId: UUID!` Id of the file to make public. - `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). ### CreateCloudObjectInput (input) Field values of a new CloudObject 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. - `applicationId: ID` Id of the producing application. - `companyCloudObjectFolderId: ID` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: ID` Id of the uploading user. - `filename: String!` File name (with extension) used when downloading the object. - `isPublic: Boolean` When true, the object can be served via a public URL (see publicUrl). - `mimeType: String` Mime-type of the cloud object Is detected from content. - `params: JSONString` Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. - `type: CloudObjectTypeEnum!` Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. - `uploadSource: UploadSourceEnum` Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. - `url: String` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: Int` Revision when entity was lastly changed. - `content: Base64` Data content of the object. ### CreateImageInput (input) Parameters of the createImageCloudObject mutation. - `filename: String!` File name of the image, including its extension. - `content: String!` Image content, base64-encoded. - `uploadSource: UploadSourceEnum` Editor the image is embedded in (e-mail template or rich-text editor). Leave empty for an image that is not embedded. ### CreateOrUpdateCloudObjectInput (input) Field values of a CloudObject 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. - `applicationId: ID` Id of the producing application. - `companyCloudObjectFolderId: ID` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: ID` Id of the uploading user. - `filename: String` File name (with extension) used when downloading the object. - `isPublic: Boolean` When true, the object can be served via a public URL (see publicUrl). - `mimeType: String` Mime-type of the cloud object Is detected from content. - `params: JSONString` Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. - `type: CloudObjectTypeEnum` Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only. - `uploadSource: UploadSourceEnum` Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. - `url: String` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: Int` Revision when entity was lastly changed. - `content: Base64` Data content of the object. ### DeleteCloudObjectInput (input) Id of the CloudObject 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. ### DeleteCloudObjectsInput (input) Parameters of the deleteCloudObjects mutation. - `bulkFilter: BulkOperationInput!` Files and folders 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). ### MoveCloudObjectsInput (input) Parameters of the moveCloudObjects mutation. - `bulkFilter: BulkOperationInput!` Files and folders to move. - `folderId: UUID` Target folder. Required for company documents; for record documents, leave empty to move the files to the record's root. - `entityId: UUID` Id of the record whose documents are moved. Set together with entityType. - `entityType: BaseEntityTypeEnum` Type of the record whose documents are moved: Account, Contact, Lead, Opportunity, Task, Appointment, Project, Quote or CustomEntity. Set together with entityId. - `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). ### UpdateCloudObjectInput (input) Id of a CloudObject 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. - `applicationId: ID` Id of the producing application. - `companyCloudObjectFolderId: ID` Id of the company folder, or empty when the object is not stored in the company tree. - `creatorId: ID` Id of the uploading user. - `filename: String` File name (with extension) used when downloading the object. - `isPublic: Boolean` When true, the object can be served via a public URL (see publicUrl). - `params: JSONString` Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. - `uploadSource: UploadSourceEnum` Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images. - `url: String` URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. - `revision: Int` Revision when entity was lastly changed. ### BulkUpdateCloudObjectPayload (object) Result of the bulkUpdateCloudObject mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CloudObjectMakePublicPayload (object) Result of the cloudObjectMakePublic mutation. - `result: String!` Public URL of the file. - `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). ### CreateCloudObjectPayload (object) Result of the createCloudObject mutation. - `cloudObject: CloudObjectEntity` 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). ### CreateImageCloudObjectPayload (object) Result of the createImageCloudObject mutation. - `cloudObject: CloudObjectEntity` The created file. ### DeleteCloudObjectPayload (object) Result of the deleteCloudObject mutation. - `cloudObject: CloudObjectEntity` The deleted 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). ### DeleteCloudObjectsPayload (object) Result of the deleteCloudObjects mutation. - `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). ### MoveCloudObjectsPayload (object) Result of the moveCloudObjects mutation. - `result: Boolean!` True when all given files were moved. - `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). ### UpdateCloudObjectPayload (object) Result of the updateCloudObject mutation. - `cloudObject: CloudObjectEntity` 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). ### CloudObjectDimensions (object) Width and height of an image file, in pixels. - `width: Int!` Width of the image in pixels. - `height: Int!` Height of the image in pixels. 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 FirstCloudObjects { entities { cloudObject { 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 FirstCloudObjects { entities { cloudObject { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```