API Documentation

API Endpoint

Emails

Emails

Supported filter params

  • status (1: unresolved, 2: resolved, 3: dismissed)

  • creator_id (array)

  • recipient_id (array)

  • sender_or_recipient_id (array)

  • before

  • after

GET /api/v2/emails
Requestsreturns emails

GET  /api/v2/emails

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "3",
      "type": "emails",
      "attributes": {
        "subject": null,
        "body": "Email text body",
        "body_truncated": null,
        "auto_linked": false,
        "linked_type": null,
        "linked_id": null,
        "external_id": null,
        "dismissed_at": null,
        "created_at": "2025-07-24T06:05:41.287+02:00",
        "delivered_at": null,
        "received_at": null,
        "failed_at": null,
        "outgoing": null,
        "from": null,
        "recipients": {},
        "participants": {},
        "unread": false,
        "body_html": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "484"
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "payment_reminder": {
          "meta": {
            "included": false
          }
        },
        "thread": {
          "meta": {
            "included": false
          }
        },
        "integration": {
          "meta": {
            "included": false
          }
        },
        "participants": {
          "meta": {
            "included": false
          }
        },
        "recipients": {
          "meta": {
            "included": false
          }
        },
        "to_recipients": {
          "meta": {
            "included": false
          }
        },
        "cc_recipients": {
          "meta": {
            "included": false
          }
        },
        "bcc_recipients": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2",
      "type": "emails",
      "attributes": {
        "subject": null,
        "body": "Email text body",
        "body_truncated": null,
        "auto_linked": false,
        "linked_type": null,
        "linked_id": null,
        "external_id": null,
        "dismissed_at": null,
        "created_at": "2025-07-24T06:05:41.272+02:00",
        "delivered_at": null,
        "received_at": null,
        "failed_at": null,
        "outgoing": null,
        "from": null,
        "recipients": {},
        "participants": {},
        "unread": false,
        "body_html": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "484"
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "payment_reminder": {
          "meta": {
            "included": false
          }
        },
        "thread": {
          "meta": {
            "included": false
          }
        },
        "integration": {
          "meta": {
            "included": false
          }
        },
        "participants": {
          "meta": {
            "included": false
          }
        },
        "recipients": {
          "meta": {
            "included": false
          }
        },
        "to_recipients": {
          "meta": {
            "included": false
          }
        },
        "cc_recipients": {
          "meta": {
            "included": false
          }
        },
        "bcc_recipients": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1",
      "type": "emails",
      "attributes": {
        "subject": null,
        "body": "Email text body",
        "body_truncated": null,
        "auto_linked": false,
        "linked_type": null,
        "linked_id": null,
        "external_id": null,
        "dismissed_at": null,
        "created_at": "2025-07-24T06:05:41.246+02:00",
        "delivered_at": null,
        "received_at": null,
        "failed_at": null,
        "outgoing": null,
        "from": null,
        "recipients": {},
        "participants": {},
        "unread": false,
        "body_html": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "484"
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "invoice": {
          "meta": {
            "included": false
          }
        },
        "payment_reminder": {
          "meta": {
            "included": false
          }
        },
        "thread": {
          "meta": {
            "included": false
          }
        },
        "integration": {
          "meta": {
            "included": false
          }
        },
        "participants": {
          "meta": {
            "included": false
          }
        },
        "recipients": {
          "meta": {
            "included": false
          }
        },
        "to_recipients": {
          "meta": {
            "included": false
          }
        },
        "cc_recipients": {
          "meta": {
            "included": false
          }
        },
        "bcc_recipients": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/emails?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/emails?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get emails
GET/api/v2/emails

GET /api/v2/emails/1
Requestsreturns email

GET  /api/v2/emails/5

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "5",
    "type": "emails",
    "attributes": {
      "subject": null,
      "body": "Email text body",
      "body_truncated": null,
      "auto_linked": false,
      "linked_type": null,
      "linked_id": null,
      "external_id": null,
      "dismissed_at": null,
      "created_at": "2025-07-24T06:05:41.683+02:00",
      "delivered_at": null,
      "received_at": null,
      "failed_at": null,
      "outgoing": null,
      "from": null,
      "recipients": {},
      "participants": {},
      "unread": false,
      "body_html": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "486"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "payment_reminder": {
        "meta": {
          "included": false
        }
      },
      "thread": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      },
      "participants": {
        "meta": {
          "included": false
        }
      },
      "recipients": {
        "meta": {
          "included": false
        }
      },
      "to_recipients": {
        "meta": {
          "included": false
        }
      },
      "cc_recipients": {
        "meta": {
          "included": false
        }
      },
      "bcc_recipients": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a email
GET/api/v2/emails/{id}

URI Parameters
HideShow
id
number (required) Example: 1

email id

PATCH /api/v2/emails/1/attach
Requestsattaches emailreturns error

PATCH  /api/v2/emails/6/attach

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "emails",
    "relationships": {
      "deal": {
        "data": {
          "type": "deals",
          "id": "386"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "6",
    "type": "emails",
    "attributes": {
      "subject": null,
      "body": "Email text body",
      "body_truncated": null,
      "auto_linked": false,
      "linked_type": "Quote",
      "linked_id": 386,
      "external_id": null,
      "dismissed_at": null,
      "created_at": "2025-07-24T06:05:41.752+02:00",
      "delivered_at": null,
      "received_at": null,
      "failed_at": null,
      "outgoing": null,
      "from": null,
      "recipients": {},
      "participants": {},
      "unread": false,
      "body_html": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "487"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "payment_reminder": {
        "meta": {
          "included": false
        }
      },
      "thread": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      },
      "participants": {
        "meta": {
          "included": false
        }
      },
      "recipients": {
        "meta": {
          "included": false
        }
      },
      "to_recipients": {
        "meta": {
          "included": false
        }
      },
      "cc_recipients": {
        "meta": {
          "included": false
        }
      },
      "bcc_recipients": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/emails/7/attach

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "emails",
    "relationships": {
      "deal": {
        "data": {
          "type": "deals",
          "id": ""
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/deal"
      }
    }
  ]
}

Attachs a email
PATCH/api/v2/emails/{id}/attach

URI Parameters
HideShow
id
number (required) Example: 1

email id

PATCH /api/v2/emails/1/dismiss
Requestsdismisses email

PATCH  /api/v2/emails/10/dismiss

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "10",
    "type": "emails",
    "attributes": {
      "subject": null,
      "body": "Email text body",
      "body_truncated": null,
      "auto_linked": false,
      "linked_type": null,
      "linked_id": null,
      "external_id": null,
      "dismissed_at": "2025-07-24T06:05:42.000+02:00",
      "created_at": "2025-07-24T06:05:42.636+02:00",
      "delivered_at": null,
      "received_at": null,
      "failed_at": null,
      "outgoing": null,
      "from": null,
      "recipients": {},
      "participants": {},
      "unread": false,
      "body_html": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "491"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      },
      "invoice": {
        "meta": {
          "included": false
        }
      },
      "payment_reminder": {
        "meta": {
          "included": false
        }
      },
      "thread": {
        "meta": {
          "included": false
        }
      },
      "integration": {
        "meta": {
          "included": false
        }
      },
      "participants": {
        "meta": {
          "included": false
        }
      },
      "recipients": {
        "meta": {
          "included": false
        }
      },
      "to_recipients": {
        "meta": {
          "included": false
        }
      },
      "cc_recipients": {
        "meta": {
          "included": false
        }
      },
      "bcc_recipients": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Dismisses a email
PATCH/api/v2/emails/{id}/dismiss

URI Parameters
HideShow
id
number (required) Example: 1

email id

DELETE /api/v2/emails/1
Requestsdeletes email

DELETE  /api/v2/emails/13

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a email
DELETE/api/v2/emails/{id}

URI Parameters
HideShow
id
number (required) Example: 1

email id

Generated by aglio on 24 Jul 2025