Get Company Finder search results

Changed on

Retrieve the results of a Company Finder search.

Answers 202 with no companies while the search is still running, and 200 once it is done. Branch on status, never on the HTTP code alone. See Request statuses.

get/company_finder/async/{request_id}

Request

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

Path parameters

request_idstring required

The request_id returned by POST /company_finder/async.

Response

Search finished. status is terminated (companies and summary present, companies possibly empty) or on_hold (not enough credits for a single company).

idstring

The request_id of this search.

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

See Request statuses. A search that matched nothing is reported as terminated with an empty companies array.

credits_consumedstring

Credits spent by this search, as a decimal string.

credits_leftstring

Credits remaining on the account, as a decimal string.

Example response

{
  "id": "bc39ffbfc24cf043b748",
  "status": "terminated",
  "credits_consumed": "2.5",
  "credits_left": "998.5",
  "summary": {
    "companies_found": 68067,
    "limit": 25
  },
  "companies": [
    {
      "company_id": 42,
      "company_name": "Acme",
      "company_domain": "acme.com",
      "company_website": "acme.com",
      "company_linkedin_url": "https://www.linkedin.com/company/acme",
      "company_crunchbase_url": "https://www.crunchbase.com/organization/acme",
      "company_logo_url": "https://logo.example/acme.png",
      "company_industry": "Software",
      "company_type": "Privately Held",
      "company_founded_year": 2012,
      "company_keywords": [
        "saas"
      ],
      "company_technologies": [
        "Ruby",
        "PostgreSQL"
      ],
      "company_employees_range_start": 51,
      "company_employees_range_end": 200,
      "company_employees_count": 120,
      "company_employees_by_department": {
        "Engineering": 40,
        "Sales": 15
      },
      "company_size_range": "51-200",
      "company_revenue_range": "$10M-$50M",
      "company_locations_count": 3,
      "company_last_funding_round_name": "Series B",
      "company_last_amount_raised_usd": 25000000,
      "company_total_amount_raised_usd": 40000000,
      "company_last_funding_date": "2024-06-01",
      "company_head_quarters_city": "Austin",
      "company_head_quarters_state": "Texas",
      "company_head_quarters_country": "United States",
      "company_active_job_postings_count": 8
    }
  ]
}

Changes