Welcome to Scrupp's API! You can use this API to access all our API endpoints.
The API is organized around REST. All requests should be made over SSL. All request and response bodies, including errors, are encoded in JSON.
The main endpoint:
https://scrupp.com/api/v1
The required parameter:
api_key
| Parameter | Type | Description |
|---|---|---|
| url * | string | Source URL for the list |
| max | integer | Maximum number of items to retrieve |
| page | integer | Page number for pagination |
| name | string | Name of the list |
| verified | boolean | Filter for verified emails only |
| export | boolean | Auto export the list or not |
| with_emails | boolean | Set it to true if you want Email enrichment |
| contains_words | string | Filter items containing specific words |
| stop_words | string | Exclude items containing specific stop words |
| account * | string | Account identifier that will be used to scrape |
| list | string | Identifier for a specific list |
| webhook | string | Webhook Id |
| export_columns | array | Specific columns to include in the export |
| filter_columns | array | Columns to apply filters on |
curl -X POST https://scrupp.com/api/v1/list/create?api_key=< api key > \
-H "Content-Type: application/json" \
-d '{
"url": "https://www.linkedin.com/search/results/people/?keywords=sales-man",
"max": 100,
"page": 1,
"name": "My List",
"verified": true,
"export": false,
"with_emails": true,
"contains_words": "best, good",
"stop_words": "",
"account": "1",
"list": "list_id",
"webhook": "",
"export_columns": ["column1", "column2"],
"filter_columns": ["filter1", "filter2"]
}'
{
"status": true,
"errors": null,
"message": "List created successfully"
}
Create a list with first name, last name, and domains information and get their work emails
| Parameter | Type | Description |
|---|---|---|
| items * | array | A list of first name, last name, and domains |
| name | string | Optional name for the list |
curl -X POST 'https://scrupp.com/api/v1/list/create-initials?api_key=< api_key >' \
-H 'Content-Type: application/json' \
-d '{
"api_key": "your_api_key",
"items": [
{
"first_name": "John",
"last_name": "Doe",
"domain": ["https://example.com"]
},
{
"first_name": "Jane",
"last_name": "Smith",
"domain": ["https://example.org"]
}
],
"name": "My Initials List"
}'
{
"status": true,
"message": "List created successfully",
"aggregator_id": 389,
"item_count": 2
}
Create a list by providing a set of LinkedIn profile URLs. This endpoint allows you to bulk scrape and get emails from LinkedIn profiles.
| Parameter | Type | Description |
|---|---|---|
| api_key * | string | Your API key for authentication |
| name | string | Name of the LinkedIn profiles list |
| linkedin * | array | Array of LinkedIn profile URLs to be added to the list |
curl -X POST 'https://scrupp.com/api/v1/list/create-linkedin?api_key=< api_key >' \
-H 'Content-Type: application/json' \
-d '{
"name": "LinkedIn Profiles List",
"linkedin": [
"https://www.linkedin.com/in/dummy-profile-1",
"https://www.linkedin.com/in/dummy-profile-2",
"https://www.linkedin.com/in/dummy-profile-3",
"https://www.linkedin.com/in/dummy-profile-4",
"https://www.linkedin.com/in/dummy-profile-5",
"https://www.linkedin.com/in/dummy-profile-6",
"https://www.linkedin.com/in/dummy-profile-7",
"https://www.linkedin.com/in/dummy-profile-8",
"https://www.linkedin.com/in/dummy-profile-9",
"https://www.linkedin.com/in/dummy-profile-10",
]
}'
{
"status": true,
"message": "List created successfully",
"list_id": 383,
"added_count": 10
}
Get detailed info about all of your lists
curl -X GET https://scrupp.com/api/v1/list/all?api_key=< api key >
{
"status": true,
"list": [
{
"id": 85,
"name": "2023-06-14 09:42",
"emailsFound": 45,
"emailsChecked": 44,
"accounts": ["Jhon"],
"status": "finished",
"page": 2,
"urls": [
"https:\/\/www.linkedin.com\/search\/results\/people?keywords=marketer"
],
"errors": null,
"countContacts": 50,
"count": 50,
"max": 50,
"start": 10,
"countAvailableEmails": 45,
"withEmails": true,
"isStatusFinished": true,
"type": "contact",
"vendor": 1,
"exportFormat": "csv",
"exportPublicPath": "\/uploads\/csv\/test.csv",
"exported": null,
},
{
"id": 83,
"name": "2023-06-14 09:42",
"emailsFound": 45,
"emailsChecked": 44,
"accounts": ["Jhon"],
"status": "finished",
"page": 2,
"urls": [
"https:\/\/www.linkedin.com\/search\/results\/people?keywords=sales-man"
],
"errors": null,
"countContacts": 50,
"count": 50,
"max": 50,
"start": 10,
"countAvailableEmails": 45,
"withEmails": true,
"isStatusFinished": true,
"type": "contact",
"vendor": 1,
"exportFormat": "csv",
"exportPublicPath": "\/uploads\/csv\/test.csv",
"exported": null,
}
]
}
}}
Get detail info about list
| Parameter | Type | Description |
|---|---|---|
| list * | integer | The ID of the List |
curl -X GET https://scrupp.com/api/v1/list/get?api_key=< api key > \
-H "Content-Type: application/json" \
-d '{
"list": 85
}'
{
"status": true,
"list": {
"id": 85,
"name": "2023-06-14 09:42",
"emailsFound": 45,
"emailsChecked": 44,
"accounts": ["Jhon"],
"status": "finished",
"page": 2,
"urls": [
"https:\/\/www.linkedin.com\/search\/results\/people"
],
"errors": null,
"countContacts": 50,
"count": 50,
"max": 50,
"start": 10,
"countAvailableEmails": 45,
"withEmails": true,
"isStatusFinished": true,
"type": "contact",
"vendor": 1,
"exportFormat": "csv",
"exportPublicPath": "\/uploads\/csv\/test.csv",
"exported": null,
}
}
Get 100 items from the List
| Parameter | Type | Description |
|---|---|---|
| id * | integer | Th ID of the List |
| page | integer | The offset to start from |
curl -X GET 'https://scrupp.com/api/v1/list/item/all?api_key=< api key >&id=383&page=1' \
-H "Content-Type: application/json"
{
"pages": 1,
"total": 4,
"result": [
{
"first_name": "John",
"last_name": "Doe",
"full_name": null,
"linkedin": "https://www.linkedin.com/in/Jhon Doe",
"sales_navigator": null,
"open": "false",
"premium": "false",
"open_to_work": "false",
"headline": null,
"industry": "",
"email": null,
"email_status": "",
"additional_emails": "",
"personal_email": null,
"num_of_connections": null,
"years_of_experience": null,
"location": null,
"skills": null,
"twitter": "",
"about": null,
"company_name": "",
"company_link": "",
"company_domain": "",
"company_about": "",
"company_founded": "",
"company_size": "",
"company_location_1": "",
"company_location_2": "",
"company_location_3": "",
"company_city_1": "",
"company_city_2": "",
"company_city_3": "",
"company_address": "",
"company_postal_code": "",
"company_phone": "",
"industry_1": "",
"industry_2": "",
"industry_3": "",
"domain_status": "",
"company_specialties": "",
"company_size_category": "",
"social_fields": "",
"keywords": "",
"annual_revenue": "",
"technologies": "",
"funding_events": "",
"total_funding": "",
"last_funding_round_date": "",
"last_funding_stage": "",
"alexa_ranking": "",
"crunchbase_url": "",
"market_cap": "",
"current_position_1": null,
"current_position_2": null,
"current_position_3": null,
"position_1": null,
"position_2": null,
"position_3": null,
"education_1": null,
"education_2": null,
"education_3": null,
"website_1": null,
"website_2": null,
"website_3": null,
"phone_number_1": null,
"phone_number_2": null,
"phone_number_3": null,
"item_id": 9,
"position": null,
"filtered": "FALSE",
"filter_message": null
},
{
"first_name": "Saikalasultanova",
"last_name": "Saikalasultanova",
"full_name": null,
"linkedin": "https://www.linkedin.com/in/saikalasultanova",
"sales_navigator": null,
"open": "false",
"premium": "false",
"open_to_work": "false",
"headline": null,
"industry": "",
"email": null,
"email_status": "",
"additional_emails": "",
"personal_email": null,
"num_of_connections": null,
"years_of_experience": null,
"location": null,
"skills": null,
"twitter": "",
"about": null,
"company_name": "",
"company_link": "",
"company_domain": "",
"company_about": "",
"company_founded": "",
"company_size": "",
"company_location_1": "",
"company_location_2": "",
"company_location_3": "",
"company_city_1": "",
"company_city_2": "",
"company_city_3": "",
"company_address": "",
"company_postal_code": "",
"company_phone": "",
"industry_1": "",
"industry_2": "",
"industry_3": "",
"domain_status": "",
"company_specialties": "",
"company_size_category": "",
"social_fields": "",
"keywords": "",
"annual_revenue": "",
"technologies": "",
"funding_events": "",
"total_funding": "",
"last_funding_round_date": "",
"last_funding_stage": "",
"alexa_ranking": "",
"crunchbase_url": "",
"market_cap": "",
"current_position_1": null,
"current_position_2": null,
"current_position_3": null,
"position_1": null,
"position_2": null,
"position_3": null,
"education_1": null,
"education_2": null,
"education_3": null,
"website_1": null,
"website_2": null,
"website_3": null,
"phone_number_1": null,
"phone_number_2": null,
"phone_number_3": null,
"item_id": 10,
"position": null,
"filtered": "FALSE",
"filter_message": null
},
]
Create a list of companies and retrieve their data.
| Parameter | Type | Description |
|---|---|---|
| api_key * | string | Your API key for authentication |
| name | string | Name for the list (optional) |
| items * | array | Array of company identifiers (LinkedIn URLs, names, or domains) |
| type * | string | Type of identifier: "linkedin", "name", or "domain" |
curl -X POST 'https://scrupp.com/api/v1/company/get?api_key=< api_key >' \
-H 'Content-Type: application/json' \
-d '{
"name": "Tech Companies List",
"items": [
"https://www.linkedin.com/company/google",
"https://www.linkedin.com/company/microsoft",
"https://www.linkedin.com/company/apple"
],
"type": "linkedin"
}'
{
"status": true,
"message": "List created",
"aggregator_id": 123,
"count": 3
}
Create a list of decision makers for specified companies.
| Parameter | Type | Description |
|---|---|---|
| api_key * | string | Your API key for authentication |
| name | string | Name for the list (optional) |
| items * | array | Array of company identifiers (LinkedIn URLs, names, or domains) |
| type * | string | Type of identifier: "linkedin", "name", or "domain" |
| account * | string | LinkedIn account email to use for scraping |
| max | integer | Maximum number of decision makers to retrieve (default: 100, max: 2500) |
curl -X POST 'https://scrupp.com/api/v1/company/decision-maker/get?api_key=< api_key >' \
-H 'Content-Type: application/json' \
-d '{
"name": "Tech Companies Decision Makers",
"items": [
"https://www.linkedin.com/company/google",
"https://www.linkedin.com/company/microsoft",
"https://www.linkedin.com/company/apple"
],
"type": "linkedin",
"account": "your_linkedin_email@example.com",
"max": 200
}'
{
"status": true,
"message": "List created",
"aggregator_id": 124,
"count": 3
}