1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. getRecipients
Viewing docs for Honeycomb 0.47.1
published on Monday, Mar 9, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

honeycombio.getRecipients

honeycombio logo
Viewing docs for Honeycomb 0.47.1
published on Monday, Mar 9, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

    # Data Source:<span pulumi-lang-nodejs=" honeycombio.getRecipients

    " pulumi-lang-dotnet=" honeycombio.getRecipients " pulumi-lang-go=" getRecipients " pulumi-lang-python=" get_recipients " pulumi-lang-yaml=" honeycombio.getRecipients " pulumi-lang-java=" honeycombio.getRecipients “> honeycombio.getRecipients honeycombio.getRecipients data source provides recipient IDs of recipients matching a set of criteria.

    Example Usage

    Get all recipients

    import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

const all = honeycombio.getRecipients({});

    import pulumi
import pulumi_honeycombio as honeycombio

all = honeycombio.get_recipients()

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := honeycombio.GetRecipients(ctx, &honeycombio.GetRecipientsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var all = Honeycombio.GetRecipients.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var all = HoneycombioFunctions.getRecipients(GetRecipientsArgs.builder()
            .build());

    }
}

    variables:
  all:
    fn::invoke:
      function: honeycombio:getRecipients
      arguments: {}

    Get all email recipients matching a specific domain

    import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

const example_dot_com = honeycombio.getRecipients({
    type: "email",
    detailFilter: {
        name: "address",
        valueRegex: ".*@example.com",
    },
});

    import pulumi
import pulumi_honeycombio as honeycombio

example_dot_com = honeycombio.get_recipients(type="email",
    detail_filter={
        "name": "address",
        "value_regex": ".*@example.com",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := honeycombio.GetRecipients(ctx, &honeycombio.GetRecipientsArgs{
			Type: pulumi.StringRef("email"),
			DetailFilter: honeycombio.GetRecipientsDetailFilter{
				Name:       "address",
				ValueRegex: pulumi.StringRef(".*@example.com"),
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var example_dot_com = Honeycombio.GetRecipients.Invoke(new()
    {
        Type = "email",
        DetailFilter = new Honeycombio.Inputs.GetRecipientsDetailFilterInputArgs
        {
            Name = "address",
            ValueRegex = ".*@example.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientsArgs;
import com.pulumi.honeycombio.inputs.GetRecipientsDetailFilterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example-dot-com = HoneycombioFunctions.getRecipients(GetRecipientsArgs.builder()
            .type("email")
            .detailFilter(GetRecipientsDetailFilterArgs.builder()
                .name("address")
                .valueRegex(".*@example.com")
                .build())
            .build());

    }
}

    variables:
  example-dot-com:
    fn::invoke:
      function: honeycombio:getRecipients
      arguments:
        type: email
        detailFilter:
          name: address
          valueRegex: .*@example.com

    Using getRecipients

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecipients(args: GetRecipientsArgs, opts?: InvokeOptions): Promise<GetRecipientsResult>
function getRecipientsOutput(args: GetRecipientsOutputArgs, opts?: InvokeOptions): Output<GetRecipientsResult>
    def get_recipients(detail_filter: Optional[GetRecipientsDetailFilter] = None,
                   id: Optional[str] = None,
                   type: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRecipientsResult
def get_recipients_output(detail_filter: Optional[pulumi.Input[GetRecipientsDetailFilterArgs]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   type: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRecipientsResult]
    func GetRecipients(ctx *Context, args *GetRecipientsArgs, opts ...InvokeOption) (*GetRecipientsResult, error)
func GetRecipientsOutput(ctx *Context, args *GetRecipientsOutputArgs, opts ...InvokeOption) GetRecipientsResultOutput

    > Note: This function is named GetRecipients in the Go SDK.

    public static class GetRecipients 
{
    public static Task<GetRecipientsResult> InvokeAsync(GetRecipientsArgs args, InvokeOptions? opts = null)
    public static Output<GetRecipientsResult> Invoke(GetRecipientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRecipientsResult> getRecipients(GetRecipientsArgs args, InvokeOptions options)
public static Output<GetRecipientsResult> getRecipients(GetRecipientsArgs args, InvokeOptions options)

    fn::invoke:
  function: honeycombio:index/getRecipients:getRecipients
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DetailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    Id string
    The ID of this resource.
    Type string
    The type of recipients.
    DetailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    Id string
    The ID of this resource.
    Type string
    The type of recipients.
    detailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    id String
    The ID of this resource.
    type String
    The type of recipients.
    detailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    id string
    The ID of this resource.
    type string
    The type of recipients.
    detail_filter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    id str
    The ID of this resource.
    type str
    The type of recipients.
    detailFilter Property Map
    Attributes to filter the recipients with. name must be set when providing a filter.
    id String
    The ID of this resource.
    type String
    The type of recipients.

    getRecipients Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Ids List<string>
    DetailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    Type string
    The type of recipients.
    Id string
    The ID of this resource.
    Ids []string
    DetailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    Type string
    The type of recipients.
    id String
    The ID of this resource.
    ids List<String>
    detailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    type String
    The type of recipients.
    id string
    The ID of this resource.
    ids string[]
    detailFilter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    type string
    The type of recipients.
    id str
    The ID of this resource.
    ids Sequence[str]
    detail_filter GetRecipientsDetailFilter
    Attributes to filter the recipients with. name must be set when providing a filter.
    type str
    The type of recipients.
    id String
    The ID of this resource.
    ids List<String>
    detailFilter Property Map
    Attributes to filter the recipients with. name must be set when providing a filter.
    type String
    The type of recipients.

    Supporting Types

    GetRecipientsDetailFilter

    Name string
    The name of the detail field to filter by
    Value string
    The value of the detail field to match on.
    ValueRegex string
    A regular expression string to apply to the value of the detail field to match on.
    Name string
    The name of the detail field to filter by
    Value string
    The value of the detail field to match on.
    ValueRegex string
    A regular expression string to apply to the value of the detail field to match on.
    name String
    The name of the detail field to filter by
    value String
    The value of the detail field to match on.
    valueRegex String
    A regular expression string to apply to the value of the detail field to match on.
    name string
    The name of the detail field to filter by
    value string
    The value of the detail field to match on.
    valueRegex string
    A regular expression string to apply to the value of the detail field to match on.
    name str
    The name of the detail field to filter by
    value str
    The value of the detail field to match on.
    value_regex str
    A regular expression string to apply to the value of the detail field to match on.
    name String
    The name of the detail field to filter by
    value String
    The value of the detail field to match on.
    valueRegex String
    A regular expression string to apply to the value of the detail field to match on.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    Viewing docs for Honeycomb 0.47.1
    published on Monday, Mar 9, 2026 by honeycombio
    Schema (JSON)
    honeycombio/terraform-provider-honeycombio
      Try Pulumi Cloud free. Your team will thank you.