Find all sent emails under specific tenant.

GET

http://localhost:3000/api/email

curl -X GET 'http://localhost:3000/api/email'

const response = await fetch('http://localhost:3000/api/email', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('http://localhost:3000/api/email')
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "content": "string",
  "email": "string",
  "status": "SENT",
  "user": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "thirdPartyId": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "username": "string",
    "timeZone": "string",
    "timeFormat": 12,
    "hash": "string",
    "refreshToken": "string",
    "imageUrl": "string",
    "preferredLanguage": "en",
    "preferredComponentLayout": "CARDS_GRID",
    "uiPreferences": {},
    "code": "string",
    "codeExpireAt": "2024-01-15T09:30:00Z",
    "emailVerifiedAt": "2024-01-15T09:30:00Z",
    "lastLoginAt": "2024-01-15T09:30:00Z",
    "emailToken": "string",
    "roleId": "string",
    "imageId": "string",
    "defaultTeamId": "string",
    "lastTeamId": "string",
    "defaultOrganizationId": "string",
    "lastOrganizationId": "string"
  },
  "userId": "string",
  "emailTemplate": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "languageCode": "string",
    "mjml": "string",
    "hbs": "string"
  },
  "emailTemplateId": "string"
}

Parameters

selectObjectquery

relationsObjectquery

whereObjectrequiredquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

Response

200OKEmailHistory

Found emails

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestring

contentstring

emailstringrequired

statusstringSENTFAILED

userUserrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

userIdstring

emailTemplateEmailTemplaterequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

languageCodestringrequired

mjmlstringrequired

hbsstringrequired

emailTemplateIdstringrequired

404Not Found

No records found

500Internal Server Error

Invalid input, The response body may contain clues as to what went wrong

Stack Overflow Website Demo