List recipients for an email message

GET

email_messages

{email_id}

recipients

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailMessages.recipients.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.email_messages.recipients.list(
    "email_id",
)
print(page.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	recipients, err := client.EmailMessages.Recipients.List(
		context.TODO(),
		"email_id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", recipients.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailMessages().recipients().list("email_id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailMessages->recipients->list(
    'email_id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": [
    {
      "record_type": "email_recipient",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "address": "example@telnyx.com",
      "kind": "to",
      "status": "queued",
      "billable": false,
      "sent_at": "2024-01-23T18:10:02.574Z",
      "delivered_at": "2024-01-23T18:10:02.574Z",
      "failed_at": "2024-01-23T18:10:02.574Z",
      "smtp_code": 0,
      "smtp_response": "string"
    }
  ],
  "meta": {
    "page_size": 1,
    "page_cursor": "string"
  }
}

{
  "errors": [
    {
      "code": "10006",
      "title": "Not authorized",
      "detail": "Invalid API key",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10006"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested resource was not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

email_id

string<uuid>

required

Email message UUID.

Query Parameters

page_size

integer

default:25

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

Required range: 1 <= x <= 100

page_cursor

string

Opaque URL-safe Base64 cursor returned by a previous list response.

status

enum<string>

Filter recipients by status.

Available options:

queued,

sending,

sent,

deferred,

delivered,

bounced,

failed,

gw_reject,

cancelled

kind

enum<string>

Filter recipients by address kind.

Available options:

to,

cc,

bcc

Response

Paginated list of recipients.

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailMessages.recipients.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.email_messages.recipients.list(
    "email_id",
)
print(page.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	recipients, err := client.EmailMessages.Recipients.List(
		context.TODO(),
		"email_id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", recipients.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailMessages().recipients().list("email_id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailMessages->recipients->list(
    'email_id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": [
    {
      "record_type": "email_recipient",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "address": "example@telnyx.com",
      "kind": "to",
      "status": "queued",
      "billable": false,
      "sent_at": "2024-01-23T18:10:02.574Z",
      "delivered_at": "2024-01-23T18:10:02.574Z",
      "failed_at": "2024-01-23T18:10:02.574Z",
      "smtp_code": 0,
      "smtp_response": "string"
    }
  ],
  "meta": {
    "page_size": 1,
    "page_cursor": "string"
  }
}

{
  "errors": [
    {
      "code": "10006",
      "title": "Not authorized",
      "detail": "Invalid API key",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10006"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested resource was not found"
    }
  ]
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

List recipients for an email message

Authorizations

Path Parameters

Query Parameters

Response