API reference / scrape

scrape

GET/api/v1/scrape

List scrape

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/scrape

Create scrape

Auth:
required (min role: admin)
Response:
{ data }
GET/api/v1/scrape/:jobId

Get scrape by ID

Auth:
required (min role: admin)
Response:
{ data }
PATCH/api/v1/scrape/:jobId

Partially update scrape

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/scrape/:jobId/apply

Create apply

Auth:
required (min role: director)
Response:
{ success, message }
GET/api/v1/scrape/jobs

List jobs

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/scrape/jobs

Create job

Auth:
required (min role: admin)
Response:
{ data }
GET/api/v1/scrape/jobs/:id

Get job by ID

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/scrape/jobs/:id/import

Create import

Auth:
required (min role: director)
Response:
{ success, message }
GET/api/v1/scrape/jobs/:id/mappings

Get mappings for scrape

Auth:
required (min role: admin)
Response:
{ data }
GET/api/v1/scrape/mappings/:id

Get mapping by ID

Auth:
required (min role: admin)
Response:
{ data }
PATCH/api/v1/scrape/mappings/:id

Partially update mapping

Auth:
required (min role: admin)
Response:
{ data }
scrape API — Peer10 Developers