---
title: "CompanyEmails.get"
method: GET
path: "/entities/CompanyEmails/{id}"
tags: ["Company Email"]
---

# CompanyEmails.get

`GET /entities/CompanyEmails/{id}`

Returns CompanyEmail with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

CompanyEmail data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` CompanyEmail
    - `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.
    - `email` string — Email address of the company mailbox (the From address).
    - `enabled` boolean, required — False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise.
    - `error_code` integer — Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration.
    - `name` string, required — Display name of the company email account, shown in the UI.
    - `picture_url` string — URL of the avatar image used as the sender picture for emails sent from this account.
    - `service_type` 1 | 2 | 3, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - O365Email, 2 - GoogleEmail, 3 - SendGrid
    - `settings` object — Provider-specific configuration for the mailbox (e.g. parse_subdomain for SendGrid).
    - `token` string, binary — OAuth/secret credentials for the mailbox. Read-only and only returned to service-to-service callers; setting via the public API is not supported.
    - `features` integer[], required — List of capabilities supported by the underlying email service (e.g. CanSyncBounces, CanSyncIncoming).
    - `mailbox_id` string, uuid — Stable UUID derived from the mailbox address and service type, used to correlate the company email account with its integration settings entry.

## 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/revisions/e8c12ae60aca/schema)