{
"ok": true,
"result": {
"site": "https://www.python.org",
"startUrl": "https://www.python.org/",
"status": "ok",
"emails": [],
"phones": [],
"contactPage": "https://www.python.org/about/help/",
"pagesScanned": 3,
"scannedUrls": [
"https://www.python.org/",
"https://www.python.org/about/"
],
"skippedByRobots": [],
"error": null,
"linkedin": "https://linkedin.com/example",
"twitter": "https://twitter.com/example",
"github": "https://github.com/example"
},
"meta": {
"requestId": "5f0c2a7e-0000-4000-8000-000000000000",
"durationMs": 2283
}
}
curl --location --request GET 'https://zylalabs.com/api/14699/website+contact+details+extractor+api/37997/extract+contacts?url=https://www.python.org&followContactPages=true&maxPages=3' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Website Contact Details Extractor API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Find the contact page, published business contact channels and social profile links of a company website, returned as structured JSON.
Yes. Pages disallowed by robots.txt are skipped and listed in skippedByRobots.
No. Each request is processed on demand and the result is returned in the response. Nothing about your request is kept beyond short-lived operational logs.
You receive a JSON error with a clear code (for example invalid_input, no_result or timeout) instead of partial data. Requests rejected for invalid input are answered with status 400.
The Extract Contacts endpoint returns structured JSON data that includes the contact page link, published business contact channels (emails and phones), and social profile links (like LinkedIn, Twitter, and GitHub) found on the scanned website.
Key fields in the response include "contactPage" (link to the contact page), "emails" (list of email addresses), "phones" (list of phone numbers), and social media links (e.g., "linkedin", "twitter", "github"). The "status" field indicates the request outcome.
The response data is organized into two main sections: "result" and "meta". The "result" section contains the extracted contact information, while the "meta" section provides metadata about the request, such as "requestId" and "durationMs".
The endpoint provides information such as the contact page URL, email addresses, phone numbers, and links to social media profiles. It scans the homepage and up to four additional pages for this data.
Users can customize their requests by specifying the target website URL in the GET request. The API will then scan the specified site and its contact pages to extract relevant information.
The data is sourced directly from the scanned company website. The API analyzes the homepage and designated contact or about pages to extract publicly available contact information and social media links.
Typical use cases include lead generation, market research, and enhancing customer relationship management (CRM) systems by obtaining accurate contact information and social media profiles for businesses.
If the API returns partial or empty results, check the "error" field for specific issues. Common reasons include the absence of contact information on the site or restrictions from robots.txt.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund