List Companies Tables - Lusha Knowledge Hub

POST

/

v3

/

companies

/

tables

/

list

List Companies Tables

curl --request POST \
  --url https://api.lusha.com/v3/companies/tables/list \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "owner": {
    "email": "user@example.com"
  },
  "page": 0,
  "size": 10,
  "status": "active"
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/list"

payload = {
    "owner": { "email": "user@example.com" },
    "page": 0,
    "size": 10,
    "status": "active"
}
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({owner: {email: 'user@example.com'}, page: 0, size: 10, status: 'active'})
};

fetch('https://api.lusha.com/v3/companies/tables/list', 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/list")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  },\n  \"page\": 0,\n  \"size\": 10,\n  \"status\": \"active\"\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/list"

	payload := strings.NewReader("{\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  },\n  \"page\": 0,\n  \"size\": 10,\n  \"status\": \"active\"\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": [
    {
      "tableId": "482910",
      "name": "VP Sales US Tech Q2",
      "entityType": "contacts",
      "visibility": "private",
      "status": "active",
      "owner": {
        "id": 12345,
        "email": "owner@lusha.com",
        "name": "Ada Lovelace"
      },
      "createdBy": {
        "surface": "api",
        "createdByUserId": 12345
      },
      "workspaceUrl": "https://workspace.lusha.com/tables/482910"
    }
  ],
  "pagination": {
    "page": 0,
    "size": 25,
    "total": 123
  },
  "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.

Body

application/json

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

page

integer

default:0

Required range: 0 <= x <= 100

size

integer

default:100

name

string

Optional filter - matches tables whose name contains this text.

Example:

"Q3"

status

enum<string>

deleted is not a filterable status.

Available options:

active,

archived

Response

Successful response

data

object[]

Show child attributes

pagination

object

Show child attributes

billing

object

Credit usage summary for a V3 API request

Show child attributes

⌘I

List Companies Tables

curl --request POST \
  --url https://api.lusha.com/v3/companies/tables/list \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "owner": {
    "email": "user@example.com"
  },
  "page": 0,
  "size": 10,
  "status": "active"
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/list"

payload = {
    "owner": { "email": "user@example.com" },
    "page": 0,
    "size": 10,
    "status": "active"
}
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({owner: {email: 'user@example.com'}, page: 0, size: 10, status: 'active'})
};

fetch('https://api.lusha.com/v3/companies/tables/list', 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/list")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  },\n  \"page\": 0,\n  \"size\": 10,\n  \"status\": \"active\"\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/list"

	payload := strings.NewReader("{\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  },\n  \"page\": 0,\n  \"size\": 10,\n  \"status\": \"active\"\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": [
    {
      "tableId": "482910",
      "name": "VP Sales US Tech Q2",
      "entityType": "contacts",
      "visibility": "private",
      "status": "active",
      "owner": {
        "id": 12345,
        "email": "owner@lusha.com",
        "name": "Ada Lovelace"
      },
      "createdBy": {
        "surface": "api",
        "createdByUserId": 12345
      },
      "workspaceUrl": "https://workspace.lusha.com/tables/482910"
    }
  ],
  "pagination": {
    "page": 0,
    "size": 25,
    "total": 123
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}