Docs

Filter customers by email address

Use a new query parameter to filter customers by email address.

Product area

  • Customers

Tooling

  • API

Released

January 15, 2024

Status

Released

API version

Version 1

What's new?

We added a new email query parameter that you can use when working with the list customers operation to return entities that match the specified email addresses.

GET /customers?email=
email array[string]

Return entities that exactly match the specified email address. Use a comma-separated list to specify multiple email addresses. Recommended for precise matching of email addresses

How it works

The new email query parameter lets you filter customers by email address.

Unlike the search query parameter, the email parameter filters for exact matches. For example, if you pass sam@example.com, it returns entities where the email address is precisely sam@example.com.

It accepts a comma-separated list, so you can pass multiple email addresses and any exact matches are returned.

Next steps

This change is available in version 1 of the Paddle API.

It's a non-breaking change, meaning it doesn't impact existing integrations.

You can list customers using the API to start using the new query parameter.

Summary of changes

Entity Field Change Type
List customers email + Added Field
Filter customers by email address.

Was this page helpful?