--- title: "EmailSequenceEnrolleds.get" method: GET path: "/entities/EmailSequenceEnrolleds/{id}" tags: ["Email Sequence"] --- # EmailSequenceEnrolleds.get `GET /entities/EmailSequenceEnrolleds/{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/EmailSequenceEnrolleds/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the EmailSequenceEnrolled record with the given id. ## Path parameters - `id` string, uuid, required ## Query parameters - `expand` string ## Response `200` The EmailSequenceEnrolled record. - object - `success` boolean: True when the request succeeded; false on error. - `data` EmailSequenceEnrolled: Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it. - `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. - `account` string, uri: Account that was enrolled, when the trigger entity is an Account; otherwise empty. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields. - `actor` string, uri: User who triggered the enrolment, or empty for runs triggered by automation. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `application` string, uri, required: Application context the enrolment was triggered in. Related Application record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Application' for its fields. - `contact` string, uri: Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields. - `email_sequence_activity_log` string, uri, required: Activity log run that produced this enrolment. Related EmailSequenceActivityLog record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EmailSequenceActivityLog' for its fields. - `email_sequence` string, uri, required: Email sequence this enrolment belongs to. 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. - `lead` string, uri: Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Related Lead record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Lead' for its fields. - `oppty` string, uri: Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Related Opportunity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Opportunity' for its fields. - `project` string, uri: Project that was enrolled, when the trigger entity is a Project; otherwise empty. Related Project record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Project' for its fields. - `account_id` string, uuid: Id of the enrolled account. - `actor_id` string, uuid: Id of the user who triggered the enrolment, or empty for runs triggered by automation. - `application_id` string, uuid, required: Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in. - `contact_id` string, uuid: Id of the enrolled contact. - `email_sequence_activity_log_id` string, uuid, required: Id of the activity log run that produced this enrolment. - `email_sequence_id` string, uuid, required: Id of the email sequence this enrolment belongs to. - `end_reason` 0 | 1 | 2: Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active. 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 record: the account, contact, lead, opportunity or project that 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. ## 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)