--- title: "StepChecklists.get" method: GET path: "/entities/StepChecklists/{id}" tags: ["Step"] --- # StepChecklists.get `GET /entities/StepChecklists/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/StepChecklists/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the StepChecklist record with the given id. ## Path parameters - `id` string, uuid, required ## Query parameters - `expand` string ## Response `200` The StepChecklist record. - object - `success` boolean: True when the request succeeded; false on error. - `data` StepChecklist: Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document. - `is_delete_protected` boolean, required: 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` 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. Related AppointmentType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AppointmentType' for its fields. - `task_type` string, uri: Task type that satisfies this checklist item. Set when activity_type_id resolves to a TaskType. Related TaskType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskType' for its fields. - `cloud_object_template` string, uri: Document template the checklist item fills and attaches to the record. Set when item_type is UseDocumentTemplate. Related CloudObjectTemplate record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CloudObjectTemplate' for its fields. - `email_sequence` string, uri: Email sequence the item should enroll the record into. Related EmailSequence record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EmailSequence' for its fields. - `field` string, uri: Field whose value satisfies this checklist item. Set when item_type is FieldType. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields. - `process` string, uri: Automatizer process that completes the item once it has run for the record. Set when item_type is RunProcess. Related Process record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Process' for its fields. - `send_email_field` string, uri: Field that supplies the recipient email address when the checklist item triggers sending an email. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields. - `send_email_lookup_field` string, uri: Contact or Account lookup field whose primary record supplies the recipient. When set, send_email_field is read from that record instead of the Primary Contact or Primary Account. Only lookup fields with a primary record are valid. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields. - `send_email_template` string, uri: Email template the email is pre-filled with when the item is completed by sending an email. Set when item_type is SendEmail. Related EmailTemplate record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EmailTemplate' for its fields. - `step` string, uri, required: Pipeline or process step this checklist item belongs to. Related Step record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Step' for its fields. - `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: File format of the document generated from cloud_object_template when item_type is UseDocumentTemplate: the template's own format or PDF. Integer enum value: 0 - Default, 1 - Pdf - `cloud_object_template_id` string, uuid: Id of the document template the checklist item fills and attaches to the record. Set when item_type is UseDocumentTemplate. - `description` string: Free-text description shown alongside the checklist item. - `email_sequence_id` string, uuid: Id of the email sequence the record must be enrolled in to complete the item. Set when item_type is EnrollToEmailSequence. - `field_id` string, uuid: Id of the related field. - `item_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11: Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activity_type_id or running process. 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: Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when item_type is ActivityType. 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_lookup_field_id` string, uuid: 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. - `send_email_template_id` string, uuid: Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when item_type is SendEmail; empty when no template is preset. - `sort_order` integer, required: Position of the checklist item within its step; lower values appear first. - `step_id` string, uuid, required: Id of the pipeline or process step this checklist item belongs to. - `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. This payload conforms to the `StepChecklistVisibilityFilter` JSON Schema (see the linked schema). - `visibility_type` 0 | 1: Whether the item is always shown on the record or only when the record matches visibility_condition. 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 - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)