Search

Run an Apollo search

Requires a connected Apollo account passed as account.

post/apollo/search

Request

  • Base URL: https://api.scrupp.com/api/v1
  • URL: https://api.scrupp.com/api/v1/apollo/search
  • 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

urlstring uri required

The search URL to export.

with_emailsboolean required

Also find emails for the extracted people.

maxinteger

Maximum records to extract. Drives the upfront credit hold.

pageinteger
account_emailstring email
webhook_urlstring uri

Called when the task finishes.

Response

Task accepted

process_idinteger

Poll /task/{id}/status, fetch /task/{id}/data.

Changes

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