--- title: "EmailSequenceEnrolleds.list" method: GET path: "/entities/EmailSequenceEnrolleds" tags: ["Email Sequence"] --- # EmailSequenceEnrolleds.list `GET /entities/EmailSequenceEnrolleds` Returns all defined EmailSequenceEnrolleds ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` list of EmailSequenceEnrolleds - object - `success` boolean — True when response succeeded, false on error. - `data` EmailSequenceEnrolled[] - `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. - `account` string, uri — Account that was enrolled, when the trigger entity is an Account; otherwise empty. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. - `actor` string, uri — User who triggered the enrolment, or empty for runs triggered by automation. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. - `application` string, uri, required — Application context the enrolment was triggered in. Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties. - `contact` string, uri — Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. - `email_sequence_activity_log` string, uri, required — Activity log run that produced this enrolment. Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties. - `email_sequence` string, uri, required — Email sequence this enrolment belongs to. 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. - `lead` string, uri — Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties. - `oppty` string, uri — Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties. - `project` string, uri — Project that was enrolled, when the trigger entity is a Project; otherwise empty. Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties. - `account_id` string, uuid — Id of the enrolled account. - `actor_id` string, uuid — Id of the actor. - `application_id` string, uuid, required — Id of the application. - `contact_id` string, uuid — Id of the enrolled contact. - `email_sequence_activity_log_id` string, uuid, required — Id of the activity log. - `email_sequence_id` string, uuid, required — Id of the email sequence. - `end_reason` 0 | 1 | 2 — Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed). Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished - `end_time` string, date-time — Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active. - `entity_id` string, uuid, required — Id of the enrolled entity (matches whichever of account/contact/lead/oppty/project is set). Read-only. - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required — Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product - `excluded_from_stats` boolean — True when this enrolment is excluded from sequence statistics (e.g. after a stats reset). - `lead_id` string, uuid — Id of the enrolled lead. - `oppty_id` string, uuid — Id of the enrolled opportunity. - `project_id` string, uuid — Id of the enrolled project. - `start_time` string, date-time, required — Timestamp when the enrolment started. - `step_count` integer, required — Number of steps the enrolment has reached. Read-only. - `step_index` integer — Zero-based index of the next step the enrolment will execute (i.e. one past the highest step_index recorded in EmailSequenceEnrolledStatus). Empty before the first step runs. - `entity_name` string, required — Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entity_type. - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. - `start_cursor` string — Start cursor of result set. - `end_cursor` string — End cursor of result set. - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it). - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it). ## Other responses - `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/revisions/e8c12ae60aca/schema)