Skip to main content
GET
/
v1
/
tables
List Tables
curl --request GET \
  --url https://api.extruct.ai/v1/tables \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "kind": "generic",
    "scope": "personal"
  }
]

​
Overview

This endpoint returns a paginated list of tables, with optional filtering by view, kind, and ownership scope.

​
Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"

curl --get "https://api.extruct.ai/v1/tables" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  --data-urlencode "view=full" \
  --data-urlencode "kind=company" \
  --data-urlencode "scope=personal" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=20"

​
Key parameters

  • view (optional): response detail level; defaults to full (full or minimal).
  • kind (optional): filter by table kind (generic, company, people).
  • scope (optional): filter by ownership (personal, organization).
  • offset (optional): pagination offset.
  • limit (optional): page size.

​
Success signal

A successful response returns a paginated table list with IDs and status metadata. Results are returned in reverse chronological order, with the most recently created tables first.

​
Common errors

​
401 Unauthorized

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

​
422 Unprocessable Entity

Most often caused by unsupported query values for view, kind, or scope.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
view
enum<string>
default:full

Response view: full or minimal

Available options:
full,
minimal
​
kind
enum<string> | null

Filter by table kind

Available options:
generic,
company,
people
​
scope
enum<string> | null

Filter by ownership: personal or organization

Available options:
personal,
organization
​
offset
integer | null
​
limit
integer | null

Response

Successful Response

Minimal table info for dropdowns/selectors. Single query, no relationships.

​
id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
user_id
string
required
​
name
string
required
​
description
string | null
required
​
tags
string[] | null
required
​
kind
enum<string>
required
Available options:
generic,
company,
people
​
scope
enum<string>
required

Ownership scope for filtering resources

Available options:
personal,
organization