### Asynchronous Task ID Response Example Source: https://enrich.growthtoolkit.io/docs/index Provides an example of a successful response for an asynchronous API call, returning a 'task_id' that can be used to poll for the final result. ```json { "success": true , "status": 200 , "data":{ "task_id": "2d54c404-0e64-429d-bf36-0 ..." } } ``` -------------------------------- ### Error Codes Source: https://enrich.growthtoolkit.io/docs/index A reference guide to common error codes returned by the API, their descriptions, and recommended actions. ```APIDOC ## Error Codes Our backend typically returns a `200` status code. Non-200 codes indicate server errors. Check the `success` field in the JSON response to confirm errors. | Code | Description | What to Do | |---|---|---| | 400 | Bad request (invalid body, parameters, etc.) | Check request parameters and format. | | 401 | Unauthorized (Invalid API key) | Verify your API key. | | 402 | Credits exhausted, addon not allowed | Upgrade your plan. | | 404 | Resource not found | Check the URL or resource ID. | | 406 | Low wallet balance for auto-recharge | Add funds to your wallet. | | 407 | Low credits | Top up your credits. | | 409 | Current plan does not support API keys | Upgrade to a plan that supports API access. | | 417 | Invalid input received | Check input values (body or parameters). | | 428 | Upgrade plan to add credits to feature bucket | Upgrade your plan to enable this feature. | | 429 | Too many requests received | Wait a few seconds and retry. | | 500 | Internal server error | Try again later or contact support. | *Note: The API will always return a 200 response code even if there is an error, indicated by the `success` field in the JSON response.* ``` -------------------------------- ### API Authentication Examples Source: https://enrich.growthtoolkit.io/docs/index Demonstrates how to authenticate API requests using either the 'x-api-key' header or as a query parameter. Ensure your API key is kept secure. ```json { "x-api-key": "YOUR_API_KEY" , "Content-Type": "application/json" } ``` ```http https://api.appconnector.pro/{path}/?api_key=YOUR_API_KEY ``` -------------------------------- ### GET /scraper/list/sn/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve your Sales Navigator lists. This API allows you to get all of your Sales Navigator lists. ```APIDOC ## GET /scraper/list/sn/ ### Description Retrieve your Sales Navigator lists. This API allows you to get all of your Sales Navigator lists. ### Method GET ### Endpoint /scraper/list/sn/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. - **detailed** (boolean) - Optional - Show detailed data, 1 for yes, 0 for no. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/scraper/list/sn/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the list data. - **has_next** (boolean) - Indicates if there is a next page of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { "...": "..." } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 10, "page": 1 } ``` ``` -------------------------------- ### API Response Format Example Source: https://enrich.growthtoolkit.io/docs/index Illustrates the standard JSON response format for API calls, including success status, HTTP status code, data payload, and pagination details. ```json { "success": true , "status": 200 , "data":{}, "has_next": true , "total_pages": 1 , "total_count": 1 , "page_size": 10 , "page": 1 } ``` -------------------------------- ### GET /scraper/list/ln/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve your LinkedIn lists. This endpoint allows fetching all your Sales Navigator lists with optional filtering and detailed data. ```APIDOC ## GET /scraper/list/ln/ ### Description Retrieve your LinkedIn lists. This endpoint allows fetching all your Sales Navigator lists with optional filtering and detailed data. ### Method GET ### Endpoint /scraper/list/ln/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. - **detailed** (boolean) - Optional - Show detailed data, 1 for yes, 0 for no. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/scraper/list/ln/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the list data. - **has_next** (boolean) - Indicates if there is a next page of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { "...": "..." } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 10, "page": 1 } ``` ``` -------------------------------- ### GET /scraper/sn/{list_id}/export/ Source: https://enrich.growthtoolkit.io/docs/index Retrieves Sales Navigator profiles data that has been scraped using the extension. ```APIDOC ## GET /scraper/sn/{list_id}/export/ ### Description Retrieves Sales Navigator profiles data that has been scraped using the extension, from a specified Sales Navigator list. ### Method GET ### Endpoint /scraper/sn/{list_id}/export/ ### Parameters #### Path Parameters - **list_id** (string) - Required - The ID of the Sales Navigator list to export. #### Query Parameters - **page** (integer) - Required - The page number to fetch. Starts from 1. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/scraper/sn/1/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of scraped Sales Navigator profile objects. - **has_next** (boolean) - Indicates if there are more pages of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ ... ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 50, "page": 1 } ``` ``` -------------------------------- ### GET /email-verifier/list/{list_id}/export/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve your verified emails from your specified email verifier list. Data is provided in a paginated fashion. ```APIDOC ## GET /email-verifier/list/{list_id}/export/ ### Description Retrieve your verified emails from your specified email verifier list. Data is provided in a paginated fashion. ### Method GET ### Endpoint /email-verifier/list/{list_id}/export/ ### Parameters #### Path Parameters - **list_id** (string) - Required - ID of the Email Verifier list to export. #### Query Parameters - **page** (integer) - Optional - The page number to fetch. Starts from 1. Default is 1. - **type_** (string) - Optional - The type of email to filter by. Can be 'valid', 'invalid', or 'all'. Default is 'all'. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/email-verifier/list/1/export/?page=1&type_=valid" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the exported email data. - **has_next** (boolean) - Indicates if there is a next page of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { "...": "..." } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 50, "page": 1 } ``` ``` -------------------------------- ### GET /lists/prospect/export/{list_id}/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve unlocked people prospecting data from your specified people list. Data is provided in a paginated fashion. ```APIDOC ## GET /lists/prospect/export/{list_id}/ ### Description Retrieve unlocked people prospecting data from your specified people list. Data is provided in a paginated fashion. ### Method GET ### Endpoint /lists/prospect/export/{list_id}/ ### Parameters #### Path Parameters - **list_id** (string) - Required - The ID of the prospect list to export. #### Query Parameters - **page** (integer) - Optional - The page number to fetch. Starts from 1. Default is 1. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/lists/prospect/export/1/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the exported prospect data. #### Response Example ```json { "success": true, "status": 200, "data": [ "..." ] } ``` ``` -------------------------------- ### GET /scraper/ln/1/export/ Source: https://enrich.growthtoolkit.io/docs/index Exports data from a specified LinkedIn Extension list. Supports filtering by sub-list type. ```APIDOC ## GET /scraper/ln/1/export/ ### Description Exports data from a specified LinkedIn Extension list. Supports filtering by sub-list type. ### Method GET ### Endpoint /scraper/ln/1/export/ ### Parameters #### Query Parameters - **list_id** (string) - Required - The ID of the LinkedIn Extension list to export. - **type** (string) - Optional - Filter by sub-list type: 'search' (people search) or 'group' (group members). If not provided, exports all types. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/scraper/ln/1/export/?list_id=some_list_id&type=search" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of scraped data objects. - **has_next** (boolean) - Indicates if there are more pages of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { ... } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 50, "page": 1 } ``` ``` -------------------------------- ### Rate Limit Exceeded Response Example Source: https://enrich.growthtoolkit.io/docs/index Shows the JSON response when a rate limit is exceeded, typically returning a 429 status code and indicating the time to wait before retrying. ```json { "success": false , "status": 429 , "data":{ "sec": 25 } } ``` -------------------------------- ### GET /email-finder/list/{list_id}/export/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve your found emails from your specified email finder list. Data is provided in a paginated fashion. ```APIDOC ## GET /email-finder/list/{list_id}/export/ ### Description Retrieve your found emails from your specified email finder list. Data is provided in a paginated fashion. ### Method GET ### Endpoint /email-finder/list/{list_id}/export/ ### Parameters #### Path Parameters - **list_id** (string) - Required - The ID of the list to export. #### Query Parameters - **page** (integer) - Optional - The page number to fetch. Starts from 1. Default is 1. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/email-finder/list/1/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the exported email data. - **has_next** (boolean) - Indicates if there is a next page of results. - **total_pages** (integer) - The total number of pages available. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { "...": "..." } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 50, "page": 1 } ``` ``` -------------------------------- ### GET /tasks/status/{task_id}/ Source: https://enrich.growthtoolkit.io/docs/index Checks the status of a background task by polling. ```APIDOC ## GET /tasks/status/{task_id}/ ### Description Checks the status of a background task by polling. The API can be polled every 3 seconds. Upon completion, it may or may not return the result data in response based on the task type. ### Method GET ### Endpoint /tasks/status/{task_id}/ ### Parameters #### Path Parameters - **task_id** (string) - Required - The ID of the task to check the status for. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/tasks/status/12345/" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - An object containing task details, including status and potentially results. - **status** (string) - The current status of the task (e.g., 'finished'). - **result** (any) - The result data of the task, if available, otherwise NULL. #### Response Example (Failed) ```json { "success": true, "status": 200, "data": { "status": "finished", "result": null } } ``` ``` -------------------------------- ### GET /scraper/ln/{list_id}/export/ Source: https://enrich.growthtoolkit.io/docs/index Retrieve the LinkedIn profiles data scraped using the extension from your specified LinkedIn list. Data is provided in a paginated fashion. ```APIDOC ## GET /scraper/ln/{list_id}/export/ ### Description Retrieve the LinkedIn profiles data scraped using the extension from your specified LinkedIn list. Data is provided in a paginated fashion. ### Method GET ### Endpoint /scraper/ln/{list_id}/export/ ### Parameters #### Path Parameters - **list_id** (string) - Required - The ID of the LinkedIn list to export. #### Query Parameters - **page** (integer) - Optional - The page number to fetch. Starts from 1. Default is 1. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/scraper/ln/1/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - Contains the exported LinkedIn profile data. #### Response Example ```json { "success": true, "status": 200, "data": [ { "...": "..." } ] } ``` ``` -------------------------------- ### Action APIs Source: https://enrich.growthtoolkit.io/docs/index Overview of available Action APIs, including their purpose, corresponding service, and credit cost per call. ```APIDOC ## Action APIs These APIs perform specific actions and consume credits. Monitor your credit usage from the provided page. | I want to... | Use this API | Credits Used | |---|---|---| | Check if an email is real and valid | Email Verifier | 1 | | Find someone's work email | Email Finder | 1 | *Each API call under 'Action APIs' costs one credit.* ``` -------------------------------- ### Retrieve Prospect Lists Source: https://enrich.growthtoolkit.io/docs/index Fetches Prospect lists with support for pagination, search queries, and detailed data retrieval. Authentication is handled via an API key in the request headers. ```curl curl -X GET "https://api.appconnector.pro/lists/prospect/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Retrieve Prospect Lists Source: https://enrich.growthtoolkit.io/docs/index Retrieves a paginated list of your Prospect lists. Supports filtering and detailed output. ```APIDOC ## GET /lists/prospect/ ### Description Retrieves your Prospect lists. This API allows you to get all of your Prospect lists. ### Method GET ### Endpoint /lists/prospect/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. - **detailed** (boolean) - Optional - Show detailed data, 1 for yes, 0 for no. ### Request Example ```json { "page": 1, "page_size": 10, "q": "Default", "detailed": 1 } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of Prospect list objects. - **has_next** (boolean) - Indicates if there are more pages. - **total_pages** (integer) - The total number of pages. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { ... } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 10, "page": 1 } ``` ``` -------------------------------- ### Retrieve Email Verifier Lists Source: https://enrich.growthtoolkit.io/docs/index Fetches Email Verifier lists with pagination and filtering options. Supports searching by query and requesting detailed data. Requires an API key in the headers. ```curl curl -X GET "https://api.appconnector.pro/email-verifier/list/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### API Authentication Source: https://enrich.growthtoolkit.io/docs/index Details on how to authenticate your API requests using API keys, either in the request headers or as a query parameter. ```APIDOC ## API Authentication To access our APIs, you need to authenticate your requests using API keys. Obtain your API key from the provided page. Each API call requires your unique API Key for identification. Keep it secure and do not share it publicly. ### Authentication Methods **1. API Key in Request Headers:** Include your API key in the `x-api-key` header. ```json { "x-api-key": "YOUR_API_KEY", "Content-Type": "application/json" } ``` **2. API Key in Query Parameter:** Append your API key as the `api_key` query parameter to the endpoint URL. ``` https://api.appconnector.pro/{path}/?api_key=YOUR_API_KEY ``` ``` -------------------------------- ### Rate Limiting Source: https://enrich.growthtoolkit.io/docs/index Information on API rate limits across different categories to ensure fair usage and system responsiveness. ```APIDOC ## Rate Limiting To ensure fair usage and system responsiveness, our platform enforces rate limits on API requests. Limits are categorized independently. ### Rate Limit Categories | Category | What it Covers | Rate Limit | |---|---|---| | Action | Performing operations that require credit | 2 requests / second | | List | Fetching list details | 1 request / second | | Export | Downloading content of lists like emails, prospects | 10 requests / 10 seconds | | Misc | Other general-purpose endpoints | 1 request / 2 seconds | If a rate limit is exceeded, the server will return a `429 Too Many Requests` error. Wait a short period before retrying. ### Rate Limit Exceeded Response Example ```json { "success": false, "status": 429, "data": { "sec": 25 } } ``` ``` -------------------------------- ### Asynchronous API Responses Source: https://enrich.growthtoolkit.io/docs/index Guidance on handling asynchronous API responses, particularly for operations like email verification and contact enrichment, using Task IDs. ```APIDOC ## Asynchronous API Responses For operations like email verification or contact enrichment, processing may take time. Instead of waiting, the backend provides a `task_id` to track the request. ### Handling Asynchronous Operations 1. **Make the API call:** You will receive either the result or a `task_id`. 2. **If `task_id` is received:** Wait for a short duration (e.g., 3 seconds). 3. **Check Task Status:** Use the Task Status API to poll for results using the `task_id`. 4. **Repeat:** Continue polling until the final result is obtained. ### Task ID Response Example ```json { "success": true, "status": 200, "data": { "task_id": "2d54c404-0e64-429d-bf36-0..." } } ``` Use the `task_id` with the Task Status API to monitor progress. ``` -------------------------------- ### Retrieve Email Finder Lists Source: https://enrich.growthtoolkit.io/docs/index Retrieves Email Finder lists, allowing for pagination and filtering by search query and detail level. An API key is required for authentication. ```curl curl -X GET "https://api.appconnector.pro/email-finder/list/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Retrieve Sales Navigator List (Curl) Source: https://enrich.growthtoolkit.io/docs/index Retrieves your Sales Navigator lists. This API allows fetching all your Sales Navigator lists with options for pagination, filtering, and detailed data. An API key is required in the headers. ```curl curl -X GET "https://api.appconnector.pro/scraper/list/sn/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Retrieve Email Finder Lists Source: https://enrich.growthtoolkit.io/docs/index Retrieves a paginated list of your Email Finder lists. Supports filtering and detailed output. ```APIDOC ## GET /email-finder/list/ ### Description Retrieves your Email Finder lists. This API allows you to get all of your Email Finder lists. ### Method GET ### Endpoint /email-finder/list/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. - **detailed** (boolean) - Optional - Show detailed data, 1 for yes, 0 for no. ### Request Example ```json { "page": 1, "page_size": 10, "q": "Default", "detailed": 1 } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of Email Finder list objects. - **has_next** (boolean) - Indicates if there are more pages. - **total_pages** (integer) - The total number of pages. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { ... } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 10, "page": 1 } ``` ``` -------------------------------- ### API Response Format Source: https://enrich.growthtoolkit.io/docs/index Explains the standard JSON response format for API calls, including success status, data, and pagination details. ```APIDOC ## API Response Format Our APIs return responses in JSON format. The response includes the requested data, status code, and pagination information when applicable. ### Success Response Structure ```json { "success": true, "status": 200, "data": {}, "has_next": true, "total_pages": 1, "total_count": 1, "page_size": 10, "page": 1 } ``` - **success** (boolean): Indicates if the request was successful. - **status** (integer): The HTTP status code of the response. - **data** (object): Contains the actual data returned by the API. - **has_next** (boolean): Indicates if there are more pages of results. - **total_pages** (integer): The total number of pages available. - **total_count** (integer): The total number of items returned. - **page_size** (integer): The number of items per page. - **page** (integer): The current page number. ``` -------------------------------- ### Retrieve Email Verifier Lists Source: https://enrich.growthtoolkit.io/docs/index Retrieves a paginated list of your Email Verifier lists. Supports filtering and detailed output. ```APIDOC ## GET /email-verifier/list/ ### Description Retrieves your Email Verifier lists. This API allows you to get all of your Email Verifier lists. ### Method GET ### Endpoint /email-verifier/list/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. - **detailed** (boolean) - Optional - Show detailed data, 1 for yes, 0 for no. ### Request Example ```json { "page": 1, "page_size": 10, "q": "Default", "detailed": 1 } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of Email Verifier list objects. - **has_next** (boolean) - Indicates if there are more pages. - **total_pages** (integer) - The total number of pages. - **total_count** (integer) - The total number of items. - **page_size** (integer) - The number of items per page. - **page** (integer) - The current page number. #### Response Example ```json { "success": true, "status": 200, "data": [ { ... } ], "has_next": false, "total_pages": 0, "total_count": 1, "page_size": 10, "page": 1 } ``` ``` -------------------------------- ### Export Sales Navigator Profile Data (Curl) Source: https://enrich.growthtoolkit.io/docs/index Retrieve Sales Navigator profiles data scraped using the extension from a specified Sales Navigator list. The API requires the list ID and an optional page number. An API key must be included in the request headers. ```curl curl -X GET "https://api.appconnector.pro/scraper/sn/1/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Export Prospect List Data (Curl) Source: https://enrich.growthtoolkit.io/docs/index Retrieves unlocked people prospecting data from a specified list. The data is paginated, allowing for efficient retrieval of large datasets. Ensure your API key is sent in the headers. ```curl curl -X GET "https://api.appconnector.pro/lists/prospect/export/1/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Retrieve LinkedIn Extension Lists Source: https://enrich.growthtoolkit.io/docs/index Allows retrieval of LinkedIn Extension lists, with parameters for pagination and search queries. Requires an API key for access. ```curl curl -X GET "https://api.appconnector.pro/scraper/list/ln/?page=1&page_size=10&q=Default" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Export Email Verifier List (Curl) Source: https://enrich.growthtoolkit.io/docs/index Exports verified email data from a specified Email Verifier list. Supports pagination and filtering by email type (valid, invalid, all). Requires an API key in the headers. ```curl curl -X GET "https://api.appconnector.pro/email-verifier/list/1/export/?page=1&type_=valid" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Email Verifier API Source: https://enrich.growthtoolkit.io/docs/index This API allows you to verify an email address. It checks the validity of the email address, whether it is safe to send emails. It also provides information about the MX server and the type of email account (e.g., Free Account, Work Account). ```APIDOC ## GET /email-verifier/ ### Description Verifies an email address to check its validity, safety for sending emails, MX server information, and email account type. ### Method GET ### Endpoint /email-verifier/ ### Parameters #### Query Parameters - **email** (string) - Required - The email address to verify. - **list_id** (integer) - Optional - The list id to verify the email address. If not provided, the default list will be used. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/email-verifier/?email=john%40email.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - Contains the verification details. - **id** (integer) - The ID of the verification record. - **email** (string) - The verified email address. - **is_valid** (boolean) - Whether the email address is valid. - **mx_domain** (string) - The MX domain of the email server. - **created_at** (string) - The timestamp when the record was created. - **updated_at** (string) - The timestamp when the record was last updated. #### Response Example (Valid Email) ```json { "success": true, "status": 200, "data": { "id": 1, "email": "john@email.com", "is_valid": true, "mx_domain": "alt4.gmail-smtp-in.l.goog ...", "created_at": "2025-07-28T14:41:37.07267 ...", "updated_at": "2025-09-08T16:30:15.23595 ..." } } ``` #### Response Example (Invalid Email) ```json { "success": true, "status": 200, "data": { "id": 1, "email": "john@email.com", "is_valid": false, "mx_domain": "alt4.gmail-smtp-in.l.goog ...", "created_at": "2025-07-28T14:41:37.07267 ...", "updated_at": "2025-09-08T16:30:15.23595 ..." } } ``` ``` -------------------------------- ### Retrieve LinkedIn Extension Lists Source: https://enrich.growthtoolkit.io/docs/index Retrieves a paginated list of your LinkedIn Extension lists. Supports filtering. ```APIDOC ## GET /scraper/list/ln/ ### Description Retrieves your LinkedIn Extension lists. This API allows you to get all of your LinkedIn Extension lists. ### Method GET ### Endpoint /scraper/list/ln/ ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. Default is 1. - **page_size** (integer) - Optional - The number of items per page. Default is 10. - **q** (string) - Optional - Search query to filter lists. ### Request Example ```json { "page": 1, "page_size": 10, "q": "Default" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (array) - An array of LinkedIn Extension list objects. #### Response Example ```json { "success": true, "status": 200, "data": [ { ... } ] } ``` ``` -------------------------------- ### Export Email Finder List (Curl) Source: https://enrich.growthtoolkit.io/docs/index Exports found email data from a specified Email Finder list. This API supports pagination to retrieve data in chunks. An API key must be included in the request headers. ```curl curl -X GET "https://api.appconnector.pro/email-finder/list/1/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Retrieve LinkedIn Scraper List (Curl) Source: https://enrich.growthtoolkit.io/docs/index Fetches a paginated list of scraped LinkedIn data. Supports filtering by query and requesting detailed information. Requires an API key in the headers. ```curl curl -X GET "https://api.appconnector.pro/scraper/list/ln/?page=1&page_size=10&q=Default&detailed=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Enrich Prospect Data via LinkedIn Source: https://enrich.growthtoolkit.io/docs/index Enriches prospect data using their LinkedIn profile URL. Optionally unlocks emails and phone numbers, and assigns the prospect to a specific list. ```APIDOC ## POST /enrichment/linkedin/ ### Description Enriches a prospect's data based on their LinkedIn username. It returns detailed information about the prospect, including their name, job title, company, and social media profiles. You can also choose to unlock emails and phone numbers associated with the LinkedIn profile. ### Method POST ### Endpoint /enrichment/linkedin/ ### Parameters #### Request Body - **url** (string) - Required - The LinkedIn URL or Sales Navigator URL to enrich. - **unlock_emails** (integer) - Optional - Whether to unlock emails or not for the provided linkedin username, send 1 for yes, 0 for no. Default is 0 (no). - **unlock_phone** (integer) - Optional - Whether to unlock phone numbers or not for the provided linkedin username, send 1 for yes, 0 for no. Default is 0 (no). - **list_id** (integer) - Optional - The list id to enrich email address. If not provided, default list will be used by the backend. List id can be extracted from lists api. ### Request Example ```json { "url": "https://www.linkedin.com/in/sample", "unlock_emails": 1, "unlock_phone": 1, "list_id": 1 } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - Contains the enriched prospect data. #### Response Example ```json { "success": true, "status": 200, "data": { ... } } ``` ``` -------------------------------- ### Email Finder API Source: https://enrich.growthtoolkit.io/docs/index This API allows you to find the email address of a person based on their first name, last name, and company domain. It returns the email address if found, or an empty response if not found. ```APIDOC ## GET /email-finder/ ### Description Finds a person's email address using their first name, last name, and company domain. ### Method GET ### Endpoint /email-finder/ ### Parameters #### Query Parameters - **first_name** (string) - Required - The first name of the person. - **last_name** (string) - Required - The last name of the person. - **domain** (string) - Required - The domain of the company. - **list_id** (integer) - Optional - The list id to find the email address. If not provided, the default list will be used. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/email-finder/?first_name=john&last_name=doe&domain=sample-domain.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - Contains the found email address. - **id** (integer) - The ID of the record. - **email** (string) - The found email address. #### Response Example (Email Found) ```json { "success": true, "status": 200, "data": { "id": 2, "email": "john@email.com" } } ``` #### Response Example (Email Not Found) ```json { "success": true, "status": 200 } ``` ``` -------------------------------- ### Verify Email Address with Email Verifier API Source: https://enrich.growthtoolkit.io/docs/index The Email Verifier API checks the validity of an email address, its safety for sending emails, and provides MX server information. It requires an email address as input and optionally accepts a list_id. The API returns a success status, HTTP status code, and data containing email verification details. ```curl curl -X GET "https://api.appconnector.pro/email-verifier/?email=john%40email.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Export LinkedIn Extension Scraped Data (Curl) Source: https://enrich.growthtoolkit.io/docs/index Exports LinkedIn profile data scraped using the extension from a specified list. This API facilitates paginated retrieval of the scraped data. Include your API key in the request headers. ```curl curl -X GET "https://api.appconnector.pro/scraper/ln/{list_id}/export/?page=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Find Email Address with Email Finder API Source: https://enrich.growthtoolkit.io/docs/index The Email Finder API locates a person's email address using their first name, last name, and company domain. If found, it returns the email address; otherwise, it returns an empty response. The API supports an optional list_id parameter. ```curl curl -X GET "https://api.appconnector.pro/email-finder/?first_name=john&last_name=doe&domain=sample-domain.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Email Enrichment API Source: https://enrich.growthtoolkit.io/docs/index This API allows you to enrich a prospect's data based on their email address. It returns detailed information about the prospect, including their name, job title, company, and social media profiles. ```APIDOC ## GET /enrichment/email/ ### Description Enriches prospect data using an email address, returning details like name, job title, company, and social media profiles. ### Method GET ### Endpoint /enrichment/email/ ### Parameters #### Query Parameters - **email** (string) - Required - The email address to enrich. - **list_id** (integer) - Optional - The list id to enrich the email address. If not provided, the default list will be used. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/enrichment/email/?email=sample%40sample.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - Contains the enriched prospect data. #### Response Example ```json { "success": true, "status": 200, "data": { ... } } ``` ``` -------------------------------- ### Check Background Task Status (Curl) Source: https://enrich.growthtoolkit.io/docs/index This API is used to check the status of a background task. It can be polled every 3 seconds. The response indicates if the task has finished and may include result data depending on the task type. Requires a task ID and an API key in the headers. ```curl curl -X GET "https://api.appconnector.pro/tasks/status/12345/" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Enrich Prospect Data with Email Enrichment API Source: https://enrich.growthtoolkit.io/docs/index The Email Enrichment API enhances prospect data using an email address. It returns detailed information such as name, job title, company, and social media profiles. An optional list_id can be provided for specific list enrichment. ```curl curl -X GET "https://api.appconnector.pro/enrichment/email/?email=sample%40sample.com&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### Phone Enrichment API Source: https://enrich.growthtoolkit.io/docs/index This API allows you to enrich a prospect's data based on their phone number. It returns detailed information about the prospect, including their name, job title, company, and social media profiles. ```APIDOC ## GET /enrichment/phone/ ### Description Enriches prospect data using a phone number, returning details like name, job title, company, and social media profiles. ### Method GET ### Endpoint /enrichment/phone/ ### Parameters #### Query Parameters - **phone_number** (string) - Required - The phone number to enrich. - **list_id** (integer) - Optional - The list id to enrich the phone number. If not provided, the default list will be used. ### Request Example ```curl curl -X GET "https://api.appconnector.pro/enrichment/phone/?phone_number=%2B1234567890&list_id=1" \ -H "x-api-key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **status** (integer) - The HTTP status code. - **data** (object) - Contains the enriched prospect data. #### Response Example ```json { "success": true, "status": 200, "data": { ... } } ``` ``` -------------------------------- ### Enrich LinkedIn Prospect Data Source: https://enrich.growthtoolkit.io/docs/index Enriches prospect data using a LinkedIn profile URL. Optionally unlocks emails and phone numbers, and assigns the enriched data to a specified list. Requires an API key in the headers. ```curl curl -X POST "https://api.appconnector.pro/enrichment/linkedin/" \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://www.linkedin.com/in/sample", "unlock_emails": 1, "unlock_phone": 1, "list_id": 1 }' ```