--- title: "StepChecklists.get" method: GET path: "/entities/StepChecklists/{id}" tags: ["Step"] --- # StepChecklists.get `GET /entities/StepChecklists/{id}` Returns StepChecklist with given id ## Path parameters - `id` string, uuid, required ## Response `200` StepChecklist data - object - `success` boolean — True when response succeeded, false on error. - `data` StepChecklist - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. - `id` string, uuid, required — Unique identifier of entity. - `is_deleted` boolean — Specifies if the entity is considered deleted. - `modified` string, date-time — Last modification time. - `created` string, date-time — Creation time. - `appointment_type` string, uri — Appointment type that satisfies this checklist item. Set when activity_type_id resolves to an AppointmentType. Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties. - `task_type` string, uri — Task type that satisfies this checklist item. Set when activity_type_id resolves to a TaskType. Relation to TaskType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TaskType' object for properties. - `cloud_object_template` string, uri — Cloud object template that the checklist item should fill and attach to the record. Relation to CloudObjectTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectTemplate' object for properties. - `email_sequence` string, uri — Email sequence the item should enroll the record into. Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties. - `field` string, uri — Field whose value satisfies this checklist item. Set when item_type is FieldType. Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. - `process` string, uri — Process the item should run. Set when item_type is ProcessType. Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties. - `send_email_field` string, uri — Field that supplies the recipient email address when the checklist item triggers sending an email. Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties. - `send_email_template` string, uri — Email template used when the checklist item triggers sending an email. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. - `step` string, uri, required — Pipeline or process step this checklist item belongs to. Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. - `activity_type_id` string, uuid — Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based. - `cloud_object_format` 0 | 1 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Default, 1 - Pdf - `cloud_object_template_id` string, uuid — Id of the cloud object template. - `description` string — Free-text description shown alongside the checklist item. - `email_sequence_id` string, uuid — Id of the email sequence. - `field_id` string, uuid — Id of the related field. - `item_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap - `item_validation` 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked - `label` string — Display label of the checklist item. - `label_use_lang` boolean — When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown. - `process_id` string, uuid — Id of the related process. - `send_email_field_id` string, uuid — Id of the recipient field. - `send_email_template_id` string, uuid — Id of the email template. - `sort_order` integer, required — Position of the checklist item within its step; lower values appear first. - `step_id` string, uuid, required — Id of the step. - `visibility_condition` string, binary, required — 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. - `visibility_type` 0 | 1 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Always, 1 - Condition - `revision` integer — Revision when entity was lastly changed. - `sales_roles` string[] — Sales roles the checklist item is shown to. Empty means the item is shown to all roles. ## Other responses - `404` — Sent when invalid ID is given - `500` — unexpected error --- [API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)