--- title: entities.stepChecklist description: Read step checklist records with the stepChecklist repository, and change them with the step checklist mutations. Same records as the REST StepChecklists entity. canonical: https://developers.coevera.com/reference/graphql/step-checklist/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.stepChecklist Read step checklist records with the stepChecklist repository, and change them with the step checklist mutations. Same records as the REST StepChecklists entity. REST: [StepChecklists](https://developers.coevera.com/reference/rest/step-checklists.md). ## Queries - `getById(entityId: ID!): StepChecklistEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [StepChecklistEntity!]!` 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: StepChecklistFilterInput, orderBy: [StepChecklistOrderByInput!], includeDeleted: Boolean): [StepChecklistEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: StepChecklistFilterInput, orderBy: [StepChecklistOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): StepChecklistEntityConnection` 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. - `getByStep(stepId: UUID!): [StepChecklistEntity!]!` Returns the checklist items of the step in their display order. ## Mutations - `createStepChecklist(input: CreateStepChecklistInput!, validationLevel: [ValidationLevel!]): CreateStepChecklistPayload` Create one record. - `updateStepChecklist(input: UpdateStepChecklistInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateStepChecklistPayload` Update fields. - `bulkUpdateStepChecklist(input: [CreateOrUpdateStepChecklistInput!]!, deleteInput: [DeleteStepChecklistInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateStepChecklistPayload` Create or update many; per-item results. - `deleteStepChecklist(input: DeleteStepChecklistInput!): DeleteStepChecklistPayload` Soft-delete. ## Types ### StepChecklistEntity (object) Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document. - `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. - `appointmentType: AppointmentTypeEntity` Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. - `taskType: TaskTypeEntity` Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. - `cloudObjectTemplate: CloudObjectTemplateEntity` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `emailSequence: EmailSequenceEntity` Email sequence the item should enroll the record into. - `field: FieldEntity` Field whose value satisfies this checklist item. Set when itemType is FieldType. - `process: ProcessEntity` Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. - `sendEmailField: FieldEntity` Field that supplies the recipient email address when the checklist item triggers sending an email. - `sendEmailLookupField: FieldEntity` Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. - `sendEmailTemplate: EmailTemplateEntity` Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. - `step: StepEntity` Pipeline or process step this checklist item belongs to. - `activityTypeId: ID` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: StepChecklistDocumentFormatEnum` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: ID` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: String` Free-text description shown alongside the checklist item. - `emailSequenceId: ID` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: ID` Id of the related field. - `itemType: StepChecklistTypeEnum` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: StepChecklistValidationEnum` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: String` Display label of the checklist item. - `labelUseLang: Boolean` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: ID` Id of the related process. - `sendEmailFieldId: ID` Id of the recipient field. - `sendEmailLookupFieldId: ID` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: ID` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `sortOrder: Int!` Position of the checklist item within its step; lower values appear first. - `stepId: ID!` Id of the pipeline or process step this checklist item belongs to. - `visibilityCondition: StepChecklistVisibilityFilter!` Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. - `visibilityType: StepChecklistVisibilityEnum` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: Int` Revision when entity was lastly changed. - `salesRoles: StepChecklistSalesRoleRelationEntityConnection (8 args)` Sales roles the checklist item is shown to. Empty means the item is shown to all roles. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### StepChecklistEntityConnection (object) Paginated list of StepChecklist records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [StepChecklistEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### StepChecklistEntityEdge (object) A Relay edge containing a `StepChecklistEntity` and its cursor. - `node: StepChecklistEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### StepChecklistDocumentFormatEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [StepChecklistDocumentFormatEnum!]` Matches any of the listed values. - `NOT: StepChecklistDocumentFormatEnumFilterInput` Matches values that do not meet this condition. ### StepChecklistFilterInput (input) Filter conditions for StepChecklist records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [StepChecklistFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [StepChecklistFilterInput!]` Matches records that meet all of the listed filters. - `NOT: StepChecklistFilterInput` 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. - `activityTypeId: EntityFilterStringField` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: StepChecklistDocumentFormatEnumFilterInput` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: EntityFilterStringField` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: EntityFilterStringField` Free-text description shown alongside the checklist item. - `emailSequenceId: EntityFilterStringField` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: EntityFilterStringField` Id of the related field. - `itemType: StepChecklistTypeEnumFilterInput` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: StepChecklistValidationEnumFilterInput` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: EntityFilterStringField` Display label of the checklist item. - `labelUseLang: Boolean` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: EntityFilterStringField` Id of the related process. - `sendEmailFieldId: EntityFilterStringField` Id of the recipient field. - `sendEmailLookupFieldId: EntityFilterStringField` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: EntityFilterStringField` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `sortOrder: EntityFilterNumberField` Position of the checklist item within its step; lower values appear first. - `stepId: EntityFilterStringField` Id of the pipeline or process step this checklist item belongs to. - `visibilityType: StepChecklistVisibilityEnumFilterInput` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `appointmentType: AppointmentTypeFilterInput` Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. Matches records where a related record meets these conditions. - `taskType: TaskTypeFilterInput` Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. Matches records where a related record meets these conditions. - `cloudObjectTemplate: CloudObjectTemplateFilterInput` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. Matches records where a related record meets these conditions. - `emailSequence: EmailSequenceFilterInput` Email sequence the item should enroll the record into. Matches records where a related record meets these conditions. - `field: FieldFilterInput` Field whose value satisfies this checklist item. Set when itemType is FieldType. Matches records where a related record meets these conditions. - `process: ProcessFilterInput` Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. Matches records where a related record meets these conditions. - `sendEmailField: FieldFilterInput` Field that supplies the recipient email address when the checklist item triggers sending an email. Matches records where a related record meets these conditions. - `sendEmailLookupField: FieldFilterInput` Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. Matches records where a related record meets these conditions. - `sendEmailTemplate: EmailTemplateFilterInput` Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. Matches records where a related record meets these conditions. - `step: StepFilterInput` Pipeline or process step this checklist item belongs to. Matches records where a related record meets these conditions. - `salesRoles: StepChecklistSalesRoleRelationFilterInput` Sales roles the checklist item is shown to. Empty means the item is shown to all roles. Matches records where a related record meets these conditions. ### StepChecklistOrderByInput (input) Sorting of StepChecklist 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. - `appointmentType: [AppointmentTypeOrderByNestedInput!]` Appointment type that satisfies this checklist item. Set when activityTypeId resolves to an AppointmentType. Sorts by fields of the related record, listed in order of priority. - `taskType: [TaskTypeOrderByNestedInput!]` Task type that satisfies this checklist item. Set when activityTypeId resolves to a TaskType. Sorts by fields of the related record, listed in order of priority. - `cloudObjectTemplate: [CloudObjectTemplateOrderByNestedInput!]` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. Sorts by fields of the related record, listed in order of priority. - `emailSequence: [EmailSequenceOrderByNestedInput!]` Email sequence the item should enroll the record into. Sorts by fields of the related record, listed in order of priority. - `field: [FieldOrderByNestedInput!]` Field whose value satisfies this checklist item. Set when itemType is FieldType. Sorts by fields of the related record, listed in order of priority. - `process: [ProcessOrderByNestedInput!]` Automatizer process that completes the item once it has run for the record. Set when itemType is RunProcess. Sorts by fields of the related record, listed in order of priority. - `sendEmailField: [FieldOrderByNestedInput!]` Field that supplies the recipient email address when the checklist item triggers sending an email. Sorts by fields of the related record, listed in order of priority. - `sendEmailLookupField: [FieldOrderByNestedInput!]` Contact or Account lookup field whose primary record supplies the recipient. When set, sendEmailField is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. Sorts by fields of the related record, listed in order of priority. - `sendEmailTemplate: [EmailTemplateOrderByNestedInput!]` Email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail. Sorts by fields of the related record, listed in order of priority. - `step: [StepOrderByNestedInput!]` Pipeline or process step this checklist item belongs to. Sorts by fields of the related record, listed in order of priority. - `activityTypeId: OrderByEnum` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: OrderByEnum` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: OrderByEnum` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: OrderByEnum` Free-text description shown alongside the checklist item. - `emailSequenceId: OrderByEnum` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: OrderByEnum` Id of the related field. - `itemType: OrderByEnum` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: OrderByEnum` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: OrderByEnum` Display label of the checklist item. - `labelUseLang: OrderByEnum` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: OrderByEnum` Id of the related process. - `sendEmailFieldId: OrderByEnum` Id of the recipient field. - `sendEmailLookupFieldId: OrderByEnum` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: OrderByEnum` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `sortOrder: OrderByEnum` Position of the checklist item within its step; lower values appear first. - `stepId: OrderByEnum` Id of the pipeline or process step this checklist item belongs to. - `visibilityType: OrderByEnum` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: OrderByEnum` Revision when entity was lastly changed. ### StepChecklistTypeEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [StepChecklistTypeEnum!]` Matches any of the listed values. - `NOT: StepChecklistTypeEnumFilterInput` Matches values that do not meet this condition. ### StepChecklistValidationEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [StepChecklistValidationEnum!]` Matches any of the listed values. - `NOT: StepChecklistValidationEnumFilterInput` Matches values that do not meet this condition. ### StepChecklistVisibilityEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [StepChecklistVisibilityEnum!]` Matches any of the listed values. - `NOT: StepChecklistVisibilityEnumFilterInput` Matches values that do not meet this condition. ### CloudObjectTemplateOrderByNestedInput (input) Sorting by a field of the related CloudObjectTemplate record. Set exactly one field in each item. - `id: OrderByEnum` Unique identifier of entity. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation time. - `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. ### CreateOrUpdateStepChecklistInput (input) Field values of a StepChecklist 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. - `cloudObjectTemplate: CreateCloudObjectTemplateInput` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `activityTypeId: ID` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: StepChecklistDocumentFormatEnum` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: ID` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: String` Free-text description shown alongside the checklist item. - `emailSequenceId: ID` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: ID` Id of the related field. - `itemType: StepChecklistTypeEnum` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: StepChecklistValidationEnum` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: String` Display label of the checklist item. - `labelUseLang: Boolean` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: ID` Id of the related process. - `sendEmailFieldId: ID` Id of the recipient field. - `sendEmailLookupFieldId: ID` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: ID` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `stepId: ID` Id of the pipeline or process step this checklist item belongs to. - `visibilityCondition: StepChecklistVisibilityFilterJSONString` Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. - `visibilityType: StepChecklistVisibilityEnum` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: Int` Revision when entity was lastly changed. - `salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!]` Sales roles the checklist item is shown to. Empty means the item is shown to all roles. ### CreateStepChecklistInput (input) Field values of a new StepChecklist 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. - `cloudObjectTemplate: CreateCloudObjectTemplateInput` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `activityTypeId: ID` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: StepChecklistDocumentFormatEnum` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: ID` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: String` Free-text description shown alongside the checklist item. - `emailSequenceId: ID` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: ID` Id of the related field. - `itemType: StepChecklistTypeEnum` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: StepChecklistValidationEnum` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: String` Display label of the checklist item. - `labelUseLang: Boolean` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: ID` Id of the related process. - `sendEmailFieldId: ID` Id of the recipient field. - `sendEmailLookupFieldId: ID` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: ID` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `stepId: ID!` Id of the pipeline or process step this checklist item belongs to. - `visibilityCondition: StepChecklistVisibilityFilterJSONString!` Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. - `visibilityType: StepChecklistVisibilityEnum` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: Int` Revision when entity was lastly changed. - `salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!]` Sales roles the checklist item is shown to. Empty means the item is shown to all roles. ### CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput (input) Field values of a new StepChecklistSalesRoleRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `salesRoleId: ID!` Id of the sales role that sees the checklist item. - `revision: Int` Revision when entity was lastly changed. ### DeleteStepChecklistInput (input) Id of the StepChecklist 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. - `activityTypeId: ID` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. ### UpdateStepChecklistInput (input) Id of a StepChecklist 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. - `cloudObjectTemplate: CreateCloudObjectTemplateInput` Document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `activityTypeId: ID` Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloudObjectFormat: StepChecklistDocumentFormatEnum` File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF. - `cloudObjectTemplateId: ID` Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate. - `description: String` Free-text description shown alongside the checklist item. - `emailSequenceId: ID` Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence. - `fieldId: ID` Id of the related field. - `itemType: StepChecklistTypeEnum` Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process. - `itemValidation: StepChecklistValidationEnum` Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType. - `label: String` Display label of the checklist item. - `labelUseLang: Boolean` When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `processId: ID` Id of the related process. - `sendEmailFieldId: ID` Id of the recipient field. - `sendEmailLookupFieldId: ID` Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account. - `sendEmailTemplateId: ID` Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset. - `stepId: ID` Id of the pipeline or process step this checklist item belongs to. - `visibilityCondition: StepChecklistVisibilityFilterJSONString` Filter expression that controls when the checklist item is shown. The item is visible only when the record matches this filter; defaults to a no-op filter matching all records. - `visibilityType: StepChecklistVisibilityEnum` Whether the item is always shown on the record or only when the record matches visibilityCondition. - `revision: Int` Revision when entity was lastly changed. - `salesRoles: [CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput!]` Sales roles the checklist item is shown to. Empty means the item is shown to all roles. ### BulkUpdateStepChecklistPayload (object) Result of the bulkUpdateStepChecklist mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateStepChecklistPayload (object) Result of the createStepChecklist mutation. - `stepChecklist: StepChecklistEntity` 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). ### DeleteStepChecklistPayload (object) Result of the deleteStepChecklist mutation. - `stepChecklist: StepChecklistEntity` 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). ### UpdateStepChecklistPayload (object) Result of the updateStepChecklist mutation. - `stepChecklist: StepChecklistEntity` 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). ### StepChecklistDocumentFormatEnum (enum) File format of the document a checklist item generates from a document template. - `Default` The document template's own format. - `Pdf` PDF. ### StepChecklistTypeEnum (enum) Kind of sales step checklist item, which determines what completes it. - `Default` Plain item, completed when a user checks it off. - `ActivityType` Completed through an activity of the selected task or appointment type. - `FieldType` Completed when the selected field on the record has a value. - `CreateNote` Completed when a note is created for the item. - `AttachDocument` Completed when a document is attached for the item. - `SendEmail` Completed when an email is sent for the item. - `UseDocumentTemplate` Completed when a document is generated from the selected document template. - `EnrollToEmailSequence` Completed when the record is enrolled in the selected email sequence. - `RunProcess` Completed when the selected Automatizer process has run for the record. - `MapSalesRole` Completed when contacts with all the selected sales roles are linked to the lead or opportunity. - `CreateInfluenceMap` Item for building the influence map, completed when a user checks it off. ### StepChecklistValidationEnum (enum) Condition a step checklist item must meet before a record can move forward past the step; items without a value are optional. - `Required` The item must be completed, for example checked off or its field filled in. - `RelatedActivityCompleted` The activity linked to the item must be completed (task completed or appointment ended); allowed only for activity items. - `RelatedActivityLinked` An activity must be linked to the item. ### StepChecklistVisibilityEnum (enum) When a step checklist item is shown on a record. - `Always` The item is always shown. - `Condition` The item is shown only when the record matches visibilityCondition. ### StepChecklistVisibilityFilter (object) Conditions that decide when a step checklist item is shown; the item is visible only for records that match them. - `operator: FilterGroupOperator!` How the filter boxes combine — And or Or. - `formula: String` Optional boolean formula combining the filter boxes by their number. - `filterMainBox: MainFilterBox!` Primary group of filter conditions. - `filterSiblingBoxes: [FilterBox!]!` Additional condition groups, combined per operator/formula. 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 FirstStepChecklists { entities { stepChecklist { 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 FirstStepChecklists { entities { stepChecklist { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```