Emails

List emails

Returns a paginated list of emails. Supports filtering by ID, prospect, task, status, and updatedAt range.

Unsent drafts (e.g. created via POST /v1/emails with send: false) do not appear in this list until they are sent, including when filtering by id (filter[id] silently omits draft ids) or by filter[status]=draft. Fetch drafts by id via GET /v1/emails/{id}.

filter[task][id] matches the sequence task that triggered the email. filter[account][id] joins through the email's prospect.

get/emails

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/emails
  • 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)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[id]string

Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".

filter[prospect][id]string uuid

Filter emails for a specific prospect

filter[task][id]string uuid

Filter emails by the sequence task they were sent for. Matches Email.sepTaskId (null for emails unrelated to a sequence task).

filter[account][id]string uuid

Filter emails associated with a specific account. Joins through the email's prospect (Prospect.accountId); rows whose prospect has no account, or rows with no prospect, are excluded.

filter[status]string[]

Filter emails by delivery status. Accepts a comma-separated list; rows matching any of the provided statuses are returned. Legacy rows may carry statuses outside this set (e.g. delivered, sent_from_gmail). Filtering is case-sensitive and exact, so those rows will not match sent. draft never matches here: unsent drafts are excluded from this list entirely. Fetch them by id via GET /v1/emails/{id}.

filter[updatedAt][gte]string date-time

Filter by minimum updatedAt (ISO 8601 datetime)

filter[updatedAt][lt]string date-time

Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)

includestring[]

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

Response

Successful response

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

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