Enrichment

Poll a bulk-enrichment batch

Fetch the status and (paginated) results of a bulk-enrichment batch submitted to POST /api/v1/enrichment/contacts/bulk.

This is the delivery path for deliveryMode: poll, and a fallback for deliveryMode: webhook (e.g. a missed webhook). Cost is unchanged — the 0.5-credit-per-match charge happens once on completion, whether you poll or use a webhook.

Lifecycle: status is pending → processing → done | failed (and, in webhook mode only, delivery_failed if the batch enriched fine but your webhook kept rejecting the push). Poll every few seconds while pending/processing.

Input: batchId in the path. Pagination: cursor (opaque, start omitted) and limit (default 1,000, max 10,000).

Output: status, total, found, and results — each {externalId, url, person} where person is the full profile (same shape as the webhook payload) or null when not matched. When more results remain, nextCursor is set — pass it back as ?cursor= for the next page.

Results are retained for 7 days after completion; older or unknown batch IDs return 404.

get/api/v1/enrichment/contacts/bulk/{batch_id}

Request

  • Base URL: https://api.rodz.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.rodz.io/api/v1/enrichment/contacts/bulk/{batch_id}
  • Auth: HTTP bearer

Path parameters

batch_idstring required

Query parameters

cursorinteger

Opaque pagination cursor (start from the beginning if omitted)

limitinteger

Max results per page (default 1,000)

Response

Successful Response

successboolean

Example response

{
  "data": {
    "batchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "deliveryMode": "poll",
    "found": 1,
    "results": [
      {
        "externalId": "crm-123",
        "person": {
          "firstName": "Marie",
          "headline": "Head of Sales at Lemlist",
          "lastName": "Dupont",
          "linkedInUrl": "https://www.linkedin.com/in/marie-dupont",
          "name": "Marie Dupont"
        },
        "url": "https://www.linkedin.com/in/marie-dupont"
      },
      {
        "externalId": "crm-456",
        "url": "https://www.linkedin.com/in/jean-martin"
      }
    ],
    "status": "done",
    "total": 2
  },
  "success": true
}

Changes

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