Skip to main content
POST
/
start
Start Scrape
curl --request POST \
  --url https://api.groweasy.io/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "jobTitles": [
      "CEO",
      "CTO",
      "Founder"
    ],
    "locations": [
      "San Francisco, CA",
      "New York, NY"
    ],
    "industries": [
      "Technology",
      "SaaS"
    ],
    "companySize": "11-50",
    "limit": 100
  },
  "webhookUrl": "<string>"
}
'
{
  "success": true,
  "data": {
    "scrapeId": "scr_abc123xyz",
    "status": "pending",
    "estimatedCredits": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.groweasy.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Example

curl -X POST "https://api.groweasy.io/start" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "jobTitles": ["CEO", "Founder", "CTO"],
      "locations": ["San Francisco, CA", "New York, NY"],
      "industries": ["Technology", "SaaS"],
      "companySize": "11-50",
      "limit": 100
    },
    "webhookUrl": "https://yourapp.com/webhook"
  }'

​
Response

{
  "success": true,
  "data": {
    "scrapeId": "scr_abc123xyz",
    "status": "pending",
    "estimatedCredits": 100
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your API key from the GrowEasy dashboard.

Body

application/json

Scrape configuration with filters

​
filters
object
required

Search filters for the scrape

​
webhookUrl
string<uri>

Optional webhook URL to receive scrape completion notification

Response

Scrape started successfully

​
success
boolean
Example:

true

​
data
object