Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Email

List Email

List Email records.

get/Email

Query parameters

offsetinteger

A pagination offset.

maxSizeinteger

The maximum number of records to return.

orderBystring

An attribute (field) to order by.

order'asc' | 'desc'

An order direction.

textFilterstring

A text filter query. Wildcard (*) is supported.

attributeSelectstring[]

Attributes to return. Select only the necessary ones to improve performance.

type'and' | 'or' | 'not' | 'subQueryNotIn' | 'subQueryIn' | 'expression' | 'in' | 'notIn' | 'equals' | 'notEquals' | 'on' | 'notOn' | 'like' | 'notLike' | 'startsWith' | 'endsWith' | 'contains' | 'notContains' | 'greaterThan' | 'lessThan' | 'greaterThanOrEquals' | 'lessThanOrEquals' | 'after' | 'before' | 'between' | 'ever' | 'any' | 'none' | 'isNull' | 'isNotNull' | 'isTrue' | 'isFalse' | 'today' | 'past' | 'future' | 'lastSevenDays' | 'lastXDays' | 'nextXDays' | 'olderThanXDays' | 'afterXDays' | 'currentMonth' | 'nextMonth' | 'lastMonth' | 'currentQuarter' | 'lastQuarter' | 'currentYear' | 'lastYear' | 'currentFiscalYear' | 'lastFiscalYear' | 'currentFiscalQuarter' | 'lastFiscalQuarter' | 'arrayAnyOf' | 'arrayNoneOf' | 'arrayAllOf' | 'arrayIsEmpty' | 'arrayIsNotEmpty' | 'linkedWith' | 'notLinkedWith' | 'linkedWithAll' | 'isLinked' | 'isNotLinked' required

An operator.

attributestring

An attribute or field.

dateTimeboolean

Set true for date-time fields.

timeZonestring

A time zone. For date-time fields.

Where items.

Headers

X-No-Total'true' | 'false'

Disable calculation of the total number of records.

Response

Success.

totalnumber

The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records.

Example response

{
  "list": [
    {
      "dateSent": "2026-11-29 12:34:56",
      "deliveryDate": "2026-11-29 12:34:56",
      "sendAt": "2026-11-29 12:34:56",
      "createdAt": "2026-11-29 12:34:56",
      "modifiedAt": "2026-11-29 12:34:56",
      "icsEventDateStart": "2026-11-29 12:34:56"
    }
  ]
}