--- title: entities.cloudObjectTemplate description: Read cloud object template records with the cloudObjectTemplate repository, and change them with the cloud object template mutations. Same records as the REST CloudObjectTemplates entity. canonical: https://developers.coevera.com/reference/graphql/cloud-object-template/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.cloudObjectTemplate Read cloud object template records with the cloudObjectTemplate repository, and change them with the cloud object template mutations. Same records as the REST CloudObjectTemplates entity. REST: [CloudObjectTemplates](https://developers.coevera.com/reference/rest/cloud-object-templates.md). ## Queries - `getById(entityId: ID!): CloudObjectTemplateEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [CloudObjectTemplateEntity!]!` 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: CloudObjectTemplateFilterInput, orderBy: [CloudObjectTemplateOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean): [CloudObjectTemplateEntity!]!` Returns the files that match the filter, paged with limit and offset. - `getByCriteria(filter: CloudObjectTemplateFilterInput, orderBy: [CloudObjectTemplateOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean, before: String, after: String, first: Int, last: Int): CloudObjectTemplateEntityConnection` 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. ## Mutations - `createCloudObjectTemplate(input: CreateCloudObjectTemplateInput!, validationLevel: [ValidationLevel!]): CreateCloudObjectTemplatePayload` Create one record. - `updateCloudObjectTemplate(input: UpdateCloudObjectTemplateInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateCloudObjectTemplatePayload` Update fields. - `bulkUpdateCloudObjectTemplate(input: [CreateOrUpdateCloudObjectTemplateInput!]!, deleteInput: [DeleteCloudObjectTemplateInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateCloudObjectTemplatePayload` Create or update many; per-item results. - `deleteCloudObjectTemplate(input: DeleteCloudObjectTemplateInput!): DeleteCloudObjectTemplatePayload` Soft-delete. ## Types ### CloudObjectTemplateEntity (object) Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data. - `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. - `size: Int!` Size of the object in bytes. - `status: CloudObjectTemplateStatusEnum` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: EntityNameEnum!` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `type: CloudObjectTypeEnum!` Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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. - `templateEntityApiName: String` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### CloudObjectTemplateEntityConnection (object) Paginated list of CloudObjectTemplate records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [CloudObjectTemplateEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### CloudObjectTemplateEntityEdge (object) A Relay edge containing a `CloudObjectTemplateEntity` and its cursor. - `node: CloudObjectTemplateEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### CloudObjectTemplateFilterInput (input) Filter conditions for CloudObjectTemplate records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [CloudObjectTemplateFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [CloudObjectTemplateFilterInput!]` Matches records that meet all of the listed filters. - `NOT: CloudObjectTemplateFilterInput` 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. - `status: CloudObjectTemplateStatusEnumFilterInput` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: EntityNameEnum` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `type: CloudObjectTypeEnumFilterInput` Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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. - `templateEntityApiName: String` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. - `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. ### CloudObjectTemplateOrderByInput (input) Sorting of CloudObjectTemplate 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. - `status: OrderByEnum` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: OrderByEnum` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `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. - `templateEntityApiName: OrderByEnum` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. ### CloudObjectTemplateStatusEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [CloudObjectTemplateStatusEnum!]` Matches any of the listed values. - `NOT: CloudObjectTemplateStatusEnumFilterInput` Matches values that do not meet this condition. ### CreateCloudObjectTemplateInput (input) Field values of a new CloudObjectTemplate 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). - `status: CloudObjectTemplateStatusEnum` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: EntityNameEnum!` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `type: CloudObjectTypeEnum!` Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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. - `templateEntityApiName: String` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. ### CreateOrUpdateCloudObjectTemplateInput (input) Field values of a CloudObjectTemplate 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). - `status: CloudObjectTemplateStatusEnum` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: EntityNameEnum` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `type: CloudObjectTypeEnum` Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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. - `templateEntityApiName: String` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. ### DeleteCloudObjectTemplateInput (input) Id of the CloudObjectTemplate 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. ### UpdateCloudObjectTemplateInput (input) Id of a CloudObjectTemplate 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). - `status: CloudObjectTemplateStatusEnum` Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active. - `templateEntityName: EntityNameEnum` Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName. - `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. - `revision: Int` Revision when entity was lastly changed. - `content: Base64` Data content of the object. - `templateEntityApiName: String` API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty. ### BulkUpdateCloudObjectTemplatePayload (object) Result of the bulkUpdateCloudObjectTemplate mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateCloudObjectTemplatePayload (object) Result of the createCloudObjectTemplate mutation. - `cloudObjectTemplate: CloudObjectTemplateEntity` 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). ### DeleteCloudObjectTemplatePayload (object) Result of the deleteCloudObjectTemplate mutation. - `cloudObjectTemplate: CloudObjectTemplateEntity` 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). ### UpdateCloudObjectTemplatePayload (object) Result of the updateCloudObjectTemplate mutation. - `cloudObjectTemplate: CloudObjectTemplateEntity` 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). ### CloudObjectTemplateStatusEnum (enum) Whether a document template is available for use. - `Active` Template is available for generating documents. - `Inactive` Template is kept but not offered for generating documents. 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 FirstCloudObjectTemplates { entities { cloudObjectTemplate { 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 FirstCloudObjectTemplates { entities { cloudObjectTemplate { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```