--- title: "Emails.get" method: GET path: "/entities/Emails/{id}" tags: ["Email"] --- # Emails.get `GET /entities/Emails/{id}` Returns Email with given id ## Path parameters - `id` string, uuid, required ## Response `200` Email data - object - `success` boolean — True when response succeeded, false on error. - `data` Email - `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. - `company_email` string, uri — Configured company email used as the From / Reply-To. Empty when sent from the user mailbox. Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties. - `owner` string, uri — Sales user who owns this email. May be empty for unassigned emails. 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. - `parent_email` string, uri — For mass emails: the master email this copy was generated from. Empty for the master and for non-mass emails. Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties. - `sender_account` string, uri — Account record matched as the sender, or empty when the sender does not match an existing Account. 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. - `sender_client` string, uri — Internal user matched as the sender, or empty when the sender is external. 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. - `sender_contact` string, uri — Contact record matched as the sender, or empty when the sender does not match an existing Contact. 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. - `template` string, uri — Email template used to compose this email, or empty when none was used. 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. - `additional_headers` object — Extra raw email headers preserved from the source message, as a JSON object mapping each header name to a string or a list of strings. - `body` string — HTML body of the email. Returned only to users with read permission on the email content; otherwise empty. - `body_summary` string — Plain-text summary of the email body. Returned only to users with read permission on the email content; otherwise empty. - `cc` string — Comma-separated list of carbon-copy recipients. - `company_email_id` string, uuid — Id of the company email. - `content_share_mode` 0 | 1 | 2 — How the email body is shared with non-owners (e.g. Private hides the body, Public makes it visible to anyone with read access on the email envelope). Integer enum value: 0 - Custom, 1 - Private, 2 - Public - `content_type` string — MIME content type of the body (e.g. text/html, text/plain). - `date_sent` string, date-time — Timestamp the email was sent. Empty for drafts and scheduled emails not yet sent. - `direction` 1 | 2, required — Direction of the email (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail - `error_code` integer — Numeric error code recorded when the email failed to send. Zero when no error occurred. - `is_tracked` boolean — True when delivery tracking is enabled. Tracked emails generate EmailEvent records on open/click. - `original_id` string — External identifier of the email on the source mailbox (e.g. IMAP Message-ID). Used to deduplicate when re-syncing. - `owner_id` string, uuid — Id of the email owner. - `parent_email_id` string, uuid — Id of the parent (master) email. - `schedule_settings` object — Scheduling configuration for delayed sending, as a JSON object; next_schedule is a numeric timestamp and recipients/cc/bcc are lists. - `send_at` string, date-time — Timestamp at which a scheduled email is queued to be sent. Empty for immediately-sent emails. - `sender` string — Sender address as it appeared on the email (free-text "From" header). - `sender_account_id` string, uuid — Id of the matched sender account. - `sender_client_id` string, uuid — Id of the matched sender user. - `sender_contact_id` string, uuid — Id of the matched sender contact. - `sentiment` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive - `share_mode` 0 | 1 | 2 | 3 — Sharing model for the email envelope (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `subject` string — Name of the entity and its default text representation. - `table_name` string, required — Discriminator identifying the concrete record type — always "email" for Email records. Read-only; useful when consuming polymorphic Message results. - `template_id` string, uuid — Id of the email template. - `thread_id` string, uuid — Identifier grouping emails belonging to the same conversation thread. - `to` string — Comma-separated list of primary recipients. - `type` 1 | 2 — Email category (e.g. regular email, mass email, calendar invitation). Integer enum value: 1 - Standard, 2 - Mass - `uid` string, required — IMAP UID of the email on the source mailbox. - `revision` integer — Revision when entity was lastly changed. - `is_favorite` boolean, required — True when the current authenticated user has marked this email as favorite. Per-user. - `sharing_units` string[] — Sales units that have been granted shared access to this email envelope. - `sharing_clients` string[] — Users that have been granted shared access to this email envelope. - `content_sharing_units` string[] — Sales units that have been granted access to the email body when content_share_mode is restricted. - `content_sharing_clients` string[] — Users that have been granted access to the email body when content_share_mode is restricted. - `account_relations` string[] — Accounts this email is linked to. - `contact_relations` string[] — Contacts this email is linked to. - `project_relations` string[] — Projects this email is linked to. - `custom_entity_relations` string[] — Custom entity records this email is linked to. - `lead_relations` string[] — Leads this email is linked to. - `opportunity_relations` string[] — Opportunities this email is linked to. - `quote_relations` string[] — Quotes this email is linked to. - `tags` string[] — Tag labels applied to this email. Visible only to users that can read the email body. - `documents` string[] — Attachments and other documents linked to this email. - `mailbox_ids` string[], required — Ids of the mailboxes (company or personal) the email envelope belongs to, aggregated from the active email_mailbox_relation rows. ## 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)