Get account results

Enrichment Company Finder

curl --request GET \
  --url https://api.waterfall.io/v1/enrichment/company \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.waterfall.io/v1/enrichment/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.waterfall.io/v1/enrichment/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.waterfall.io/v1/enrichment/company"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.waterfall.io/v1/enrichment/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "SUCCEEDED",
  "start_date": "2024-01-15T12:00:00.000000+00:00",
  "stop_date": "2024-01-15T12:00:14.000000+00:00",
  "input": {
    "task": {
      "linkedin": "acme-corp",
      "custom_fields": {},
      "job_id": "0bc82c89-8905-49de-8077-da67f22c3145",
      "context_id": "0bc82c89-8905-49de-8077-da67f22c3145"
    }
  },
  "output": {
    "company": {
      "id": "8563b2e5-4090-49cf-a75b-4bbdedb4956f",
      "domain": "acme.com",
      "name": "Acme Corp",
      "website": "https://www.acme.com/",
      "linkedin_id": "acme-corp",
      "description": "Acme Corp builds enterprise software solutions for mid-market and large companies.",
      "logo_url": "https://media.licdn.com/dms/image/example/company-logo_200_200/logo.png",
      "size": "501-1000",
      "employees_count": 823,
      "industry": "Software Development",
      "type": "Privately Held",
      "founded": 2010,
      "linkedin_url": "https://www.linkedin.com/company/acme-corp/",
      "funding_details": {
        "total_funding_rounds": 0,
        "total_funding_usd": 0,
        "funding_rounds": []
      },
      "country": "United States",
      "recent_job_posting_count": 12,
      "technologies": [
        "AWS",
        "Snowflake",
        "Salesforce"
      ]
    },
    "usage": {
      "total_usd": 0.05,
      "balance_remaining_usd": 99.95,
      "persons_count": 0,
      "persons_usd": 0,
      "phones_count": 0,
      "phones_usd": 0,
      "companies_count": 1,
      "companies_usd": 0.05
    }
  }
}

GET

enrichment

company

Enrichment Company Finder

curl --request GET \
  --url https://api.waterfall.io/v1/enrichment/company \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.waterfall.io/v1/enrichment/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.waterfall.io/v1/enrichment/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.waterfall.io/v1/enrichment/company"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.waterfall.io/v1/enrichment/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "SUCCEEDED",
  "start_date": "2024-01-15T12:00:00.000000+00:00",
  "stop_date": "2024-01-15T12:00:14.000000+00:00",
  "input": {
    "task": {
      "linkedin": "acme-corp",
      "custom_fields": {},
      "job_id": "0bc82c89-8905-49de-8077-da67f22c3145",
      "context_id": "0bc82c89-8905-49de-8077-da67f22c3145"
    }
  },
  "output": {
    "company": {
      "id": "8563b2e5-4090-49cf-a75b-4bbdedb4956f",
      "domain": "acme.com",
      "name": "Acme Corp",
      "website": "https://www.acme.com/",
      "linkedin_id": "acme-corp",
      "description": "Acme Corp builds enterprise software solutions for mid-market and large companies.",
      "logo_url": "https://media.licdn.com/dms/image/example/company-logo_200_200/logo.png",
      "size": "501-1000",
      "employees_count": 823,
      "industry": "Software Development",
      "type": "Privately Held",
      "founded": 2010,
      "linkedin_url": "https://www.linkedin.com/company/acme-corp/",
      "funding_details": {
        "total_funding_rounds": 0,
        "total_funding_usd": 0,
        "funding_rounds": []
      },
      "country": "United States",
      "recent_job_posting_count": 12,
      "technologies": [
        "AWS",
        "Snowflake",
        "Salesforce"
      ]
    },
    "usage": {
      "total_usd": 0.05,
      "balance_remaining_usd": 99.95,
      "persons_count": 0,
      "persons_usd": 0,
      "phones_count": 0,
      "phones_usd": 0,
      "companies_count": 1,
      "companies_usd": 0.05
    }
  }
}

Use the job_id from Enrich accounts. When the job succeeds, check output.company.

curl --get 'https://api.waterfall.io/v1/enrichment/company' \
  --header "x-api-key: $WATERFALL_API_KEY" \
  --data-urlencode 'job_id=YOUR_JOB_ID'

Read the company profile

A fictional response excerpt showing selected company fields:

{
  "output": {
    "company": {
      "name": "Northstar",
      "domain": "northstar.example",
      "size": "201-500",
      "industry": "Entertainment Providers",
      "country": "United States",
      "technologies": ["AWS", "Python", "PostgreSQL", "Snowflake"]
    }
  }
}

Use funding_details for available funding information and input.task.custom_fields to match the result to your workspace. The full schema below includes the other company fields. Follow the shared job-state handling. If company data is missing, keep the account unclassified rather than treating it as a poor fit.

Authorizations

x-api-key

string

header

required

To access the API, provide your API key in x-api-key.

Query Parameters

job_id

string<uuid>

required

The unique job_id you want to query. This value is returned by the corresponding launcher endpoint.

A UUID.

Example:

"7d44db58-5de3-4e92-a2fb-8325d12c2e8b"

Response

Company enrichment job state, input, and any available output company.

Finder response with company enrichment job status, input, and optional output.

status

enum<string>

required

The status of the job.

Available options:

RUNNING,

SUCCEEDED,

FAILED,

TIMED_OUT,

ABORTED

Example:

"RUNNING"

start_date

string<date-time>

required

A date time in ISO 8601 format.

Example:

"2025-02-05T15:46:35.771751+00:00"

input

object

required

Show child attributes

stop_date

string<date-time>

A date time in ISO 8601 format.

Example:

"2025-02-05T15:46:35.771751+00:00"

output

object

Show child attributes

Start here

Use cases

Signups & accounts

Find your buying team

Visitors & existing users

Monitoring

Integration essentials

Read the company profile

Authorizations

Query Parameters

Response

​Read the company profile

Authorizations

Query Parameters

Response

Read the company profile