List the emails of a folder

curl --request GET \
  --url https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "Emails",
  "data": [
    {
      "object": "Email",
      "id": "<string>",
      "account_id": "<string>",
      "thread_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "subject": "<string>",
      "from_attendee": {
        "identifier": "jsmith@example.com",
        "display_name": "<string>",
        "identifier_type": "EMAIL_ADDRESS"
      },
      "to_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "cc_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "bcc_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "reply_to_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "body": "<string>",
      "body_plain": "<string>",
      "has_attachments": true,
      "attachments": [
        {
          "id": "<string>",
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mime": "<string>",
          "cid": "<string>",
          "inline": true
        }
      ],
      "folders": [
        "<string>"
      ],
      "is_unread": true,
      "is_complete": true,
      "headers": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "origin": "api",
      "tracking_id": "<string>",
      "draft_id": "<string>"
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

{
  "status": 401,
  "type": "errors/unauthorized",
  "title": "Unauthorized",
  "detail": "missing or invalid API key"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

GET

{account_id}

folders

{folder_id}

emails

List the emails of a folder

curl --request GET \
  --url https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/folders/{folder_id}/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "Emails",
  "data": [
    {
      "object": "Email",
      "id": "<string>",
      "account_id": "<string>",
      "thread_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "subject": "<string>",
      "from_attendee": {
        "identifier": "jsmith@example.com",
        "display_name": "<string>",
        "identifier_type": "EMAIL_ADDRESS"
      },
      "to_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "cc_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "bcc_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "reply_to_attendees": [
        {
          "identifier": "jsmith@example.com",
          "display_name": "<string>",
          "identifier_type": "EMAIL_ADDRESS"
        }
      ],
      "body": "<string>",
      "body_plain": "<string>",
      "has_attachments": true,
      "attachments": [
        {
          "id": "<string>",
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mime": "<string>",
          "cid": "<string>",
          "inline": true
        }
      ],
      "folders": [
        "<string>"
      ],
      "is_unread": true,
      "is_complete": true,
      "headers": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "origin": "api",
      "tracking_id": "<string>",
      "draft_id": "<string>"
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

{
  "status": 401,
  "type": "errors/unauthorized",
  "title": "Unauthorized",
  "detail": "missing or invalid API key"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

Authorizations

X-API-KEY

string

header

required

Your access token, from your dashboard under API keys.

Path Parameters

account_id

string

required

The account's acc_… id.

folder_id

string

required

The folder's fld_… id, from List folders.

Query Parameters

from

string<email>

Sender's email address (exact, case-insensitive).

string<email>

A recipient (to, cc or bcc), exact, case-insensitive.

any_email

string<email>

The sender or any recipient.

subject

string

Subject contains (case-insensitive).

is_unread

boolean

has_attachments

boolean

before

string<date-time>

Emails dated before this time.

after

string<date-time>

Emails dated after this time.

limit

integer

default:50

How many items per page, 1 to 250.

Required range: 1 <= x <= 250

cursor

string

The cursor from the previous page. Leave it out for the first page.

Response

A page of emails.

object

string

Allowed value: "Emails"

data

object[]

Show child attributes

has_more

boolean

cursor

string | null

Auth

Accounts

Emails

Attachments

Drafts

Folders

Contacts

Webhooks

API keys

List the emails of a folder

Authorizations

Path Parameters

Query Parameters

Response