Get Table

GET

tables

{table_id}

Get Table

curl --request GET \
  --url https://api.extruct.ai/v1/tables/{table_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/tables/{table_id}', 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.extruct.ai/v1/tables/{table_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.extruct.ai/v1/tables/{table_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.extruct.ai/v1/tables/{table_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "name": "<string>",
        "key": "<string>",
        "kind": "input"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "status": {
    "num_columns": 123,
    "num_rows": 0,
    "num_output_columns": 0,
    "num_input_columns": 0,
    "num_cells_completed": 0,
    "num_cells_in_progress": 0
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

This endpoint returns table metadata and execution status.

Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"
export TABLE_ID="YOUR_TABLE_ID"

curl --get "https://api.extruct.ai/v1/tables/${TABLE_ID}" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}"

Key parameters

table_id (required): target table identifier.

Useful status fields include run_status, num_cells_in_progress, and num_cells_completed.

Success signal

A successful response returns table metadata and status. Table execution is complete when run_status=idle and num_cells_in_progress=0.

Common errors

`401 Unauthorized`

Check that your header is Authorization: Bearer ${EXTRUCT_API_TOKEN}.

`404 Not Found`

The table ID is invalid or unavailable in your workspace.

AI Tables Basics

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id

string

required

Response

Successful Response

string

required

Table ID.

created_at

string<date-time>

required

Table creation time.

name

string

required

Table name.

kind

enum<string>

required

Table type.

Available options:

generic,

company,

people

columns

ColumnOutputSchema · object[]

required

Table columns configurations.

Show child attributes

owner

OwnerInfo · object

required

Show child attributes

status

TableStatus · object

required

Show child attributes

description

string | null

Table description.

tags

string[] | null

Table tags.

child_relationships

TableRelationshipOutput · object[]

Child table relationships.

Show child attributes

parent_relationships

TableRelationshipOutput · object[]

Parent table relationships.

Show child attributes

Get Table

curl --request GET \
  --url https://api.extruct.ai/v1/tables/{table_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/tables/{table_id}', 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.extruct.ai/v1/tables/{table_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.extruct.ai/v1/tables/{table_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.extruct.ai/v1/tables/{table_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "name": "<string>",
        "key": "<string>",
        "kind": "input"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "status": {
    "num_columns": 123,
    "num_rows": 0,
    "num_output_columns": 0,
    "num_input_columns": 0,
    "num_cells_completed": 0,
    "num_cells_in_progress": 0
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Company Search

Deep Search

Deep Research

Table Management

Table Execution

Other

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

`404 Not Found`

Authorizations

Path Parameters

Response

​Overview

​Example request

​Key parameters

​Success signal

​Common errors

​401 Unauthorized

​404 Not Found

​Related endpoints

​Related guides

Authorizations

Path Parameters

Response

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

`404 Not Found`

Related endpoints

Related guides