Collections · POST /v1/collections
Emails
Ask a collection to look for email addresses on each business's own website. You need a paid plan, and you must accept our acceptable use policy.
Ask for emails
Add "enrich": ["emails"] when you quote or start a collection. While we search each square, we also look for email addresses on each business's own website:
curl -X POST https://api.gmaps.dev/v1/collections \
-H "Authorization: Bearer $GMAPS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keywords": ["bakery"],
"geo": { "location": "Curitiba, PR" },
"enrich": ["emails"]
}'We look only in the squares the collection searches. A place we had already saved comes with the addresses we found for it before, if we found any. A search never looks for emails.
Who can ask
You need two things, and we check them in this order:
- A plan with emails: Starter, Pro, and Scale. On any other plan the answer is
402 PLAN_GATE, anddetails.upgradeTonames the plan to move to. You can change plans on the Plan page. - The acceptable use policy, accepted on your account. You accept it in the console, under Account. Until you do, the answer is
403 AUP_REQUIRED, anddetails.versionnames the version to accept. When we publish a new version, you accept it again before emails come back.
A quote answers with the same errors, so you can check for free.
What it costs
Each new place costs 1 credit, as always. When we find at least one email address for it, it costs 1 more. That's per place, not per address, and a place with no address found costs nothing extra. Places we already had stay free, addresses included.
A quote's maxCost counts 2 credits for each place, the most it can come to. In the live progress, a place that came with an address shows cost: 2, and counts.creditsCharged includes the extra credits.
Where they show up
Addresses come in contact.emails, on each place:
{
"contact": {
"phones": ["+55 41 0000-0000"],
"website": "https://padariaestrela.example",
"emails": ["contato@padariaestrela.example"]
}
}You see them wherever you read places: a collection's places, a search, one place looked up on its own, and the Emails column of an export. If a place has no contact.emails, we have no address for it. The live progress never carries them, so read them from the collection.
Only accounts that can ask for emails can read them, including the ones we saved earlier. If your plan no longer has emails, or a new version of the policy is waiting for you, places come back without the field and exports you make have an empty Emails column, until you can ask again.
Rules for using them
An address on a business's website is public, but that doesn't make every use of it legal. Our acceptable use policy says:
- A public address isn't permission to send marketing, and paying gmaps.dev doesn't give you that permission either.
- You need a lawful basis for each message: a reason the law accepts, such as consent where the law asks for it.
- Don't send outreach the law forbids, where you are or where the business is.
- Don't contact anyone who asked to be removed. When someone asks us to remove an address, it leaves every read and export from then on. Files you saved before still have it, so take it out of them too.
We suspend accounts that break the policy. Our privacy policy says how we find addresses and why we're allowed to, and anyone can ask us to remove theirs with the removal form.