Emails.list

Returns all defined Emails

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Emails are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of Emails

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Email) {55}]

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

company_email

string <uri>

optional

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>

optional

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>

optional

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>

optional

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>

optional

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>

optional

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>

optional

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

optional

Field containing json.

body

string

optional

Html text input field.

Example:

string

body_summary

string

optional

Multi-line text input field.

Example:

string

optional

Multi-line text input field.

Example:

string

company_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

content_share_mode

enum<integer>

optional

Integer enum value: 0 - Custom, 1 - Private, 2 - Public

Allowed values:

012

Example:

content_type

string

optional

Simple text input field.

Example:

string

date_sent

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

direction

enum<integer>

required

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

Allowed values:

Example:

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

is_tracked

boolean

optional

Boolean value.

Example:

false

original_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

parent_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

schedule_settings

object

optional

Field containing json.

send_at

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

sender

string

optional

Multi-line text input field.

Example:

string

sender_account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_client_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sentiment

enum<integer>

optional

Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive

Allowed values:

012

Example:

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

subject

string

optional

Name of the entity and its default text representation.

Example:

string

table_name

string

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

thread_id

string <uuid>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

string

optional

Multi-line text input field.

Example:

string

type

enum<integer>

optional

Integer enum value: 1 - Standard, 2 - Mass

Allowed values:

Example:

uid

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

content_sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

content_sharing_clients

array[string <uri>]

optional

Relations to Clients.

account_relations

array[string <uri>]

optional

Relations to Accounts.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

project_relations

array[string <uri>]

optional

Relations to Projects.

custom_entity_relations

array[string <uri>]

optional

Relations to CustomEntitys.

lead_relations

array[string <uri>]

optional

Relations to Leads.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

quote_relations

array[string <uri>]

optional

Relations to Quotes.

tags

array[string <uri>]

optional

Relations to Tags.

documents

array[string <uri>]

optional

Relations to CloudObjects.

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
    "success": true,
    "data": [
        {
            "is_delete_protected": false,
            "id": "01234567-abcd-dcba-ffff-000000000000",
            "is_deleted": false,
            "modified": "2019-01-01T00:00:00",
            "created": "2019-01-01T00:00:00",
            "company_email": "http://example.com",
            "owner": "http://example.com",
            "parent_email": "http://example.com",
            "sender_account": "http://example.com",
            "sender_client": "http://example.com",
            "sender_contact": "http://example.com",
            "template": "http://example.com",
            "additional_headers": {},
            "body": "string",
            "body_summary": "string",
            "cc": "string",
            "company_email_id": "01234567-abcd-dcba-ffff-000000000000",
            "content_share_mode": 0,
            "content_type": "string",
            "date_sent": "2019-01-01T00:00:00",
            "direction": 1,
            "error_code": 1,
            "is_tracked": false,
            "original_id": "string",
            "owner_id": "01234567-abcd-dcba-ffff-000000000000",
            "parent_email_id": "01234567-abcd-dcba-ffff-000000000000",
            "schedule_settings": {},
            "send_at": "2019-01-01T00:00:00",
            "sender": "string",
            "sender_account_id": "01234567-abcd-dcba-ffff-000000000000",
            "sender_client_id": "01234567-abcd-dcba-ffff-000000000000",
            "sender_contact_id": "01234567-abcd-dcba-ffff-000000000000",
            "sentiment": 0,
            "share_mode": 0,
            "subject": "string",
            "table_name": "string",
            "template_id": "01234567-abcd-dcba-ffff-000000000000",
            "thread_id": "01234567-abcd-dcba-ffff-000000000000",
            "to": "string",
            "type": 1,
            "uid": "string",
            "revision": 1,
            "sharing_units": [
                "http://example.com"
            ],
            "sharing_clients": [
                "http://example.com"
            ],
            "content_sharing_units": [
                "http://example.com"
            ],
            "content_sharing_clients": [
                "http://example.com"
            ],
            "account_relations": [
                "http://example.com"
            ],
            "contact_relations": [
                "http://example.com"
            ],
            "project_relations": [
                "http://example.com"
            ],
            "custom_entity_relations": [
                "http://example.com"
            ],
            "lead_relations": [
                "http://example.com"
            ],
            "opportunity_relations": [
                "http://example.com"
            ],
            "quote_relations": [
                "http://example.com"
            ],
            "tags": [
                "http://example.com"
            ],
            "documents": [
                "http://example.com"
            ]
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

Request

Request samples

Responses