Get enrichment results

Changed on

Retrieve the results of an enrichment request.

Answers 202 with no data while the request is still running, and 200 with status: "terminated" once it is done. Branch on status, never on the HTTP code alone. See Request statuses.

get/async/{request_id}

Request

  • Base URL
    https://app.bettercontact.rocks/api/v2
  • URL
    https://app.bettercontact.rocks/api/v2/async/{request_id}
  • Auth
    API key in header X-API-Key

Path parameters

request_idstring required

Response

Request finished. status is terminated and data holds the enriched leads.

idstring

The request_id of this enrichment.

status'processing' | 'on_hold' | 'terminated'

See Request statuses. Only terminated guarantees data and summary are present.

messagestring

Human readable hint. Only present while the request is not terminated.

credits_consumedinteger

Credits spent by this request so far.

credits_leftinteger

Credits remaining on the account.

Example response

{
  "id": "fefbc2203558eb3adcea",
  "status": "terminated",
  "message": "Enrichment is not terminated yet. Please try later",
  "credits_consumed": 1,
  "credits_left": 331,
  "summary": {
    "total": 10,
    "valid": 6,
    "catch_all": 2,
    "catch_all_not_safe": 1,
    "not_found": 1,
    "found": 4,
    "email_enrichment": {
      "enriched": 6,
      "not_enriched": 4
    },
    "phone_enrichment": {
      "enriched": 4,
      "not_enriched": 6
    },
    "profile_enrichment": {
      "enriched": 9,
      "not_enriched": 1
    }
  },
  "data": [
    {
      "enriched": true,
      "contact_id": 128374651,
      "custom_fields": [
        {
          "name": "uuid",
          "value": "crm-8821",
          "position": 0
        },
        {
          "name": "list_name",
          "value": "Q3 outbound",
          "position": 1
        }
      ],
      "contact_first_name": "Elon",
      "contact_last_name": "Musk",
      "contact_full_name": "Elon Musk",
      "contact_job_title": "Ceo of tesla",
      "contact_seniority": "Cxo",
      "contact_industry": "Automotive",
      "contact_linkedin_profile_url": "https://www.linkedin.com/in/elonmusk",
      "contact_location_continent": "North america",
      "contact_location_country": "United states",
      "contact_location_state": "Texas",
      "contact_location_city": "Austin",
      "contact_email_address": "elon@tesla.com",
      "contact_email_address_status": "deliverable",
      "contact_email_address_provider": "Secret Provider",
      "email_provider": "google",
      "contact_phone_number": "+14155550101",
      "contact_phone_number_provider": "Secret Provider",
      "company_name": "Tesla",
      "company_domain": "tesla.com",
      "company_linkedin_url": "https://www.linkedin.com/company/tesla-motors",
      "company_industry": "Automotive",
      "company_type": "Public Company",
      "company_keywords": [
        "wine industry",
        "wine"
      ],
      "company_founded_year": 2003,
      "company_employees_range_start": 10001,
      "company_employees_range_end": 50000,
      "company_headquarters_city": "Austin",
      "company_headquarters_country": "United states"
    }
  ]
}

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new catch_all enum value to the // response property for the response status

    • warning

      added the new catch_all_not_safe enum value to the // response property for the response status

    • warning

      added the new catch_all_safe enum value to the // response property for the response status

    • warning

      added the new deliverable enum value to the // response property for the response status

    • warning

      added the new not_found enum value to the // response property for the response status

    • warning

      added the new on_hold enum value to the response property for the response status

    • warning

      added the new processing enum value to the response property for the response status

    • warning

      added the new terminated enum value to the response property for the response status

    • warning

      added the new undeliverable enum value to the // response property for the response status

    • info

      api operation id getEnrichment was added

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the success response with the status