---
title: "CompanyEmails.list"
method: GET
path: "/entities/CompanyEmails"
tags: ["Company Email"]
---

# CompanyEmails.list

`GET /entities/CompanyEmails`

## 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/CompanyEmails`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/CompanyEmails/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of CompanyEmail records, optionally filtered, sorted and limited to selected fields.

## 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`

Page of CompanyEmail records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` CompanyEmail[]
    - `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.
    - `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: Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid. 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.
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## 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).
- `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)