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

# entities.processTemplate

Read process template records with the processTemplate repository, and change them with the process template mutations. Same records as the REST ProcessTemplates entity.

REST: [ProcessTemplates](https://developers.coevera.com/reference/rest/process-templates.md).

## Queries

- `getById(entityId: ID!): ProcessTemplateEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [ProcessTemplateEntity!]!` 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: ProcessTemplateFilterInput, orderBy: [ProcessTemplateOrderByInput!], includeDeleted: Boolean): [ProcessTemplateEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: ProcessTemplateFilterInput, orderBy: [ProcessTemplateOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ProcessTemplateEntityConnection` 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

- `createProcessTemplate(input: CreateProcessTemplateInput!, validationLevel: [ValidationLevel!]): CreateProcessTemplatePayload` Create one record.
- `updateProcessTemplate(input: UpdateProcessTemplateInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateProcessTemplatePayload` Update fields.
- `bulkUpdateProcessTemplate(input: [CreateOrUpdateProcessTemplateInput!]!, deleteInput: [DeleteProcessTemplateInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateProcessTemplatePayload` Create or update many; per-item results.
- `deleteProcessTemplate(input: DeleteProcessTemplateInput!): DeleteProcessTemplatePayload` Soft-delete.

## Types

### ProcessTemplateEntity (object)

Ready-made Automatizer process offered in the template gallery as a starting point for new processes.

- `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.
- `description: String` Free-text description of what the template does.
- `isRecommended: Boolean` True when the platform recommends this template (highlighted in the template gallery).
- `name: String!` Name of the entity and its default text representation.
- `settings: ProcessSchema` Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema
- `documents: [CloudObjectRelationEntity!]` Files attached to the template (e.g. reference documents, screenshots).
- `triggerType: ProcessTriggerTypeEnum` Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template.
- `triggerEntityName: EntityNameEnum` For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers.
- `actionTypes: [ProcessActionTypeIconEnum!]` Action-type icons present in the template schema, used for filtering templates by capability (e.g. SendEmail, CreateRecord, Webhook).
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### ProcessTemplateEntityConnection (object)

Paginated list of ProcessTemplate records.

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

### ProcessTemplateEntityEdge (object)

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

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

### ProcessTemplateFilterInput (input)

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

- `OR: [ProcessTemplateFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ProcessTemplateFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ProcessTemplateFilterInput` 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.
- `description: EntityFilterStringField` Free-text description of what the template does.
- `isRecommended: Boolean` True when the platform recommends this template (highlighted in the template gallery).
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `triggerType: ProcessTriggerTypeEnum` Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template.
- `triggerEntityName: EntityNameEnum` For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers.
- `documents: CloudObjectRelationFilterInput` Files attached to the template (e.g. reference documents, screenshots). Matches records where a related record meets these conditions.

### ProcessTemplateOrderByInput (input)

Sorting of ProcessTemplate 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.
- `description: OrderByEnum` Free-text description of what the template does.
- `isRecommended: OrderByEnum` True when the platform recommends this template (highlighted in the template gallery).
- `name: OrderByEnum` Name of the entity and its default text representation.
- `triggerType: OrderByEnum` Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template.
- `triggerEntityName: OrderByEnum` For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers.

### CreateOrUpdateProcessTemplateInput (input)

Field values of a ProcessTemplate 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.
- `description: String` Free-text description of what the template does.
- `isRecommended: Boolean` True when the platform recommends this template (highlighted in the template gallery).
- `name: String` Name of the entity and its default text representation.
- `settings: ProcessSchemaJSONString` Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema
- `documents: [CreateCloudObjectRelationNoBackrefInput!]` Files attached to the template (e.g. reference documents, screenshots).

### CreateProcessTemplateInput (input)

Field values of a new ProcessTemplate 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.
- `description: String` Free-text description of what the template does.
- `isRecommended: Boolean` True when the platform recommends this template (highlighted in the template gallery).
- `name: String!` Name of the entity and its default text representation.
- `settings: ProcessSchemaJSONString!` Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema
- `documents: [CreateCloudObjectRelationNoBackrefInput!]` Files attached to the template (e.g. reference documents, screenshots).

### DeleteProcessTemplateInput (input)

Id of the ProcessTemplate 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.

### UpdateProcessTemplateInput (input)

Id of a ProcessTemplate 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.
- `description: String` Free-text description of what the template does.
- `isRecommended: Boolean` True when the platform recommends this template (highlighted in the template gallery).
- `name: String` Name of the entity and its default text representation.
- `settings: ProcessSchemaJSONString` Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema
- `documents: [CreateCloudObjectRelationNoBackrefInput!]` Files attached to the template (e.g. reference documents, screenshots).

### BulkUpdateProcessTemplatePayload (object)

Result of the bulkUpdateProcessTemplate mutation.

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

### CreateProcessTemplatePayload (object)

Result of the createProcessTemplate mutation.

- `processTemplate: ProcessTemplateEntity` 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).

### DeleteProcessTemplatePayload (object)

Result of the deleteProcessTemplate mutation.

- `processTemplate: ProcessTemplateEntity` 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).

### UpdateProcessTemplatePayload (object)

Result of the updateProcessTemplate mutation.

- `processTemplate: ProcessTemplateEntity` 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).

### ProcessActionTypeIconEnum (enum)

Kind of trigger or action in a process template, used to show and filter templates by what they do.

- `CreateRecord` The template creates records.
- `UpdateRecord` The template updates records.
- `ArchiveRecord` The template archives records.
- `SendWebhook` The template sends webhooks.
- `SendEmail` The template sends emails.
- `ManualTrigger` The template is started manually.
- `ScheduledTrigger` The template runs on a schedule.
- `RecordChangedTrigger` The template runs when a record changes.

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