Skip to main content
GET
/
v1
/
tables
/
{table_id}
Get Table
curl --request GET \
  --url https://api.extruct.ai/v1/tables/{table_id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ]
}

​
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.

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

​
id
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.

​
owner
OwnerInfo · object
required
​
status
TableStatus · object
required
​
description
string | null

Table description.

​
tags
string[] | null

Table tags.

​
child_relationships
TableRelationshipOutput · object[]

Child table relationships.

​
parent_relationships
TableRelationshipOutput · object[]

Parent table relationships.