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 |
{
"status": true,
"errors": null,
"message": "List created successfully"
}
Get detailed info about all of your lists
{
"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,
},
{
"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"
],
"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 |
|---|---|---|
| id | integer | Th ID of the List |
{
"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 |