Jobs

Create a job

One entry point for every extraction, addressed by type. input is the body of the equivalent per-path endpoint.

post/jobs

Request

  • Base URL: https://api.scrupp.com/api/v1
  • URL: https://api.scrupp.com/api/v1/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key
    • API key in query parameter api_key

Headers

Idempotency-Keystring

Retry-safe for 24h. A repeat returns the original task; the same key with a different body is a 409.

Request body

type'sales_navigator.search' | 'linkedin.search' | 'apollo.search' | 'linkedin.profile' | 'company.linkedin' | 'company.domain' | 'company.name' | 'contact.decision_maker.linkedin' | 'contact.decision_maker.name' | 'contact.decision_maker.domain' | 'email.initials' | 'email.linkedin' required
inputobject

Body of the equivalent per-path endpoint.

callback_urlstring uri

Scrupp POSTs here when the job finishes, so you do not have to poll.

metadataobject

Stored with the job and echoed back on status and result.

Response

Idempotency-Key replay — the original job, not a new one

job_idinteger
statusstring
created_atstring date-time
poll_urlstring
result_urlstring
metadataobject nullable

Example response

{
  "status": "queued"
}

Changes

No recorded changes to this operation across all 1 revision of this API.