Company Tables

Run Column on Companies Table

Populate or refresh a column’s data for some or all rows in the table. This is asynchronous - the call returns immediately with status: "processing"; poll Get Companies Table for isProcessing and per-column row-status counts to know when it’s done, then read the values via Get Companies Table Entities.

runScope values:

all - every row, including already-processed ones (re-runs / refreshes). Most expensive.
missing - only rows that have never been run for this column. Cheapest, safe to call repeatedly.
specific - only the entityIds you pass. Also how you implement “run for this page” - fetch the page via Get Companies Table Entities, then pass those IDs here.

Billing: Charged per row processed, per the column’s credit tier. Company enrichment charges once per company per table - re-runs on an already-paid company in the same table are free.

POST

companies

tables

{table_id}

columns

{column_id}

run

Run Column on Companies Table

curl --request POST \
  --url https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "runScope": "missing",
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run"

payload = {
    "runScope": "missing",
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({runScope: 'missing', owner: {email: 'user@example.com'}})
};

fetch('https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"runScope\": \"missing\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run"

	payload := strings.NewReader("{\n  \"runScope\": \"missing\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "columnId": "c1",
    "runScope": "all",
    "status": "processing"
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}

Authorizations

api_key

string

header

required

Your Lusha API key. You can find this in your Lusha dashboard under API settings. Include this key in the api_key header for all requests.

Path Parameters

table_id

string

required

The table's ID.

column_id

string

required

The column's ID.

Body

application/json

runScope

enum<string>

required

Controls which rows a column operation applies to. all re-runs every row, including already-processed ones. missing only runs rows that don't have a value for this column yet. specific requires entityIds.

Available options:

all,

missing,

specific

owner

object

required

Identifies the user acting on the table, and resolves to a user on your account. Required on every table-route call when authenticating with an API key (there is no signed-in user) - omitting it returns 400. Optional for OAuth/token callers, since the caller is already identified by the token; still accepted if you want to act on behalf of another owner.

Show child attributes

entityIds

string[]

Required when runScope is specific.

Response

Column run started

Run is asynchronous - this response confirms the run was accepted. Poll Get Table for per-column row-status counts to know when it's finished.

data

object

Show child attributes

billing

object

Credit usage summary for a V3 API request

Show child attributes

⌘I

Run Column on Companies Table

curl --request POST \
  --url https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "runScope": "missing",
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run"

payload = {
    "runScope": "missing",
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({runScope: 'missing', owner: {email: 'user@example.com'}})
};

fetch('https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"runScope\": \"missing\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/{table_id}/columns/{column_id}/run"

	payload := strings.NewReader("{\n  \"runScope\": \"missing\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "columnId": "c1",
    "runScope": "all",
    "status": "processing"
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}

Overview

Resources

Endpoints

Run Column on Companies Table

Authorizations

Path Parameters

Body

Response