Emails

Get email by ID

Returns a single email by its unique identifier.

Unlike GET /v1/emails, this endpoint also returns unsent drafts and queued sends (e.g. created via POST /v1/emails). Those come back with status: draft and type: null until the email actually sends.

get/emails/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/emails/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: emails:read)

Path parameters

idstring uuid required

Unique identifier for the email

Query parameters

includestring[]

Comma-separated relations to expand inline. Valid values: prospect, task, sequence, sequenceStep. Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the email

typestring nullable

Integration type of the email (e.g. gmail, outlook). Null until the email is actually sent. An unsent draft or a queued send has no type yet.

statusstring nullable

Current status of the email

fromstring nullable

Sender email address

tostring nullable

Recipient email address

recipientsstring[] nullable

List of recipient email addresses

subjectstring nullable

Email subject line

bodyTextstring nullable

The plain-text body of the email.

bodyHtmlstring nullable

The HTML body of the email.

datestring date-time nullable

Date of the email

deliveredAtstring date-time nullable

When the email was delivered

openedAtstring date-time nullable

When the email was first opened

clickedAtstring date-time nullable

When a link in the email was first clicked

bouncedAtstring date-time nullable

When the email bounced

repliedAtstring date-time nullable

When a reply was received

openCountinteger nullable

Number of times the email was opened

clickCountinteger nullable

Number of times links were clicked

createdAtstring date-time required

When the email record was created

updatedAtstring date-time required

When the email record was last updated

Example response

{
  "prospect": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "task": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStep": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.