API Reference
Channel Email Lookup
Retrieve a channel's business email by channel_id or external_url.
POST /v1/channels/email (Deprecated)
This endpoint is deprecated and will be sunset. Use POST /v1/channels/search with include_email to retrieve email data. When calling this endpoint today, the API returns deprecation headers for client awareness:
Deprecation: trueSunset: <date>Link: </v1/channels/search>; rel=successor-version; title="Use include_email to retrieve emails"Warning: 299 - "/channels/email is deprecated; use /channels/search with include_email"
See Concepts → Enrichment for migration guidance.
Lookup a channel’s business email by channel_id or by exact external_url.
- Bills only if email exists (1.0 credit)
- Inputs are mutually exclusive: provide exactly one of
channel_idorexternal_url.
Migration
To retrieve emails going forward, call POST /v1/channels/search with include_email: true. You may also pass external_url to match exactly on external.links.url.
Example:
{ "q": "education", "limit": 10, "include_email": true }Or by external URL (exact match):
{ "external_url": "https://www.instagram.com/example/", "limit": 5 }Request body (legacy)
By channel ID:
{ "channel_id": "UC_x5XG1OV2P6uZZ5FSM9Ttw" }By external URL (exact match on external.links.url):
{ "external_url": "https://www.instagram.com/example/" }Examples
curl -X POST \
-H "Authorization: Bearer $CC_API_KEY" \
-H "Content-Type": application/json \
https://api.channelcrawler.com/v1/channels/email \
-d '{ "channel_id": "UC_x5XG1OV2P6uZZ5FSM9Ttw" }'import requests, os
resp = requests.post(
"https://api.channelcrawler.com/v1/channels/email",
headers={
"Authorization": f"Bearer {os.environ['CC_API_KEY']}",
"Content-Type": "application/json",
},
json={"channel_id": "UC_x5XG1OV2P6uZZ5FSM9Ttw"},
timeout=15,
)
print(resp.json())const resp = await fetch("https://api.channelcrawler.com/v1/channels/email", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CC_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ channel_id: "UC_x5XG1OV2P6uZZ5FSM9Ttw" }),
});
console.log(await resp.json());Examples (external_url)
curl -X POST \
-H "Authorization: Bearer $CC_API_KEY" \
-H "Content-Type: application/json" \
https://api.channelcrawler.com/v1/channels/email \
-d '{ "external_url": "https://www.instagram.com/example/" }'import requests, os
resp = requests.post(
"https://api.channelcrawler.com/v1/channels/email",
headers={
"Authorization": f"Bearer {os.environ['CC_API_KEY']}",
"Content-Type": "application/json",
},
json={"external_url": "https://www.instagram.com/example/"},
timeout=15,
)
print(resp.json())const resp = await fetch("https://api.channelcrawler.com/v1/channels/email", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CC_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ external_url: "https://www.instagram.com/example/" }),
});
console.log(await resp.json());Responses
Email found:
{ "channel_id": "UC_x5XG1OV2P6uZZ5FSM9Ttw", "email": "[email protected]" }Email not found (not billed):
{ "channel_id": "UC_x5XG1OV2P6uZZ5FSM9Ttw", "email": null }Notes
- When
external_urlis provided, the service performs an exacttermmatch onexternal.links.urlto find the channel and resolves itschannel_id. - Billing reference uses the resolved
channel_id(falls back to the providedexternal_urlonly if resolution fails). - Elasticsearch mapping:
external.links.urlis akeywordwithindex: true. Rolling out this change requires a reindex into a new index and an alias switch.