> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.staple.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server.

# Search Document Model Tables

POST https://api.staple.io/v2/search/documents/model/tables
Content-Type: application/json

Get the table types of a specific model and the standard headers of each. Use the returned `tableTypeId` and `headerId` values to address tables and cells in `POST /v2/documents/save`.

`model` is the id of the model, as shown in the Staple UI or returned by `GET /v1/models`. The response covers the model's default complex table model.

##### REQUEST HEADERS

| Attribute     | Type             | Option   | Description           |
| ------------- | ---------------- | -------- | --------------------- |
| x-api-key     | String           | Required | An unique string      |
| Authorization | String           | Required | The bearer token      |
| Content-Type  | application/json | Optional | The original resource |

##### REQUEST PAYLOAD

```
{
    "model": Int | required | the model id
}
```

##### RESPONSE BODY

| Attribute      | Type   | Description                                                                                      |
| -------------- | ------ | ------------------------------------------------------------------------------------------------ |
| tableModelId   | String | The model's default complex table model; `null` when the model has no complex table model at all |
| tables         | Array  | One entry per table type                                                                         |
| 1. tableTypeId | String | Table type id, accepted by `tables[].tableTypeId` in `POST /v2/documents/save`                   |
| 2. tableName   | String | Table type name, accepted by `tables[].tableName`                                                |
| 3. headers     | Array  | Standard headers of the table type: `headerId`, `headerName`, `dataType`                         |

A model with no table types returns `200` with an empty `tables` list.

Reference: https://docs.staple.ai/api-reference/v2/documents/search-document-model-tables

## Authentication

- `x-api-key` header (required) — API key issued by Staple.
- `Authorization` header (bearer token, required) — JWT obtained from the login endpoint.

## Request

### Body (application/json)

This endpoint expects an object.

- `model` (integer, optional)

## Response

### 200

OK

## Examples

### Search Document Model Tables

**Request**

```json
undefined
```

**Response**

```json
{
  "tableModelId": "688c2ed087259a03a6321b86",
  "tables": [
    {
      "headers": [
        {
          "dataType": "all characters",
          "headerId": "8b76bc3d-25f7-4080-a9e2-f395e4e48018",
          "headerName": "Item Code"
        },
        {
          "dataType": "all characters",
          "headerId": "bcb01ed0-3faf-44fb-9585-78de6b16a71d",
          "headerName": "Item Description"
        },
        {
          "dataType": "all characters",
          "headerId": "df6c6b66-167f-4bbe-a6bc-7a361f22178f",
          "headerName": "Bundle Item Name"
        },
        {
          "dataType": "all characters",
          "headerId": "8a31d68e-6fbd-4f3d-a2c6-3e422cba4156",
          "headerName": "Bundle Item Quantity"
        },
        {
          "dataType": "all characters",
          "headerId": "6ca95a8c-dfc0-4a3b-99d0-af750e708dd6",
          "headerName": "Quantity"
        },
        {
          "dataType": "all characters",
          "headerId": "f91a9d5e-ebc2-402b-ae47-8e00fe7a4834",
          "headerName": "Unit Price"
        },
        {
          "dataType": "all characters",
          "headerId": "0fff003f-05fb-4019-83ad-ae909336afae",
          "headerName": "Total"
        }
      ],
      "tableName": "table 1",
      "tableTypeId": "64163822-5aac-46e1-86a4-24cb74c69f5e"
    }
  ]
}
```

**SDK Code**

```python Search Document Model Tables
import requests

url = "https://api.staple.io/v2/search/documents/model/tables"

headers = {"x-api-key": "<apiKey>"}

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

print(response.json())
```

```javascript Search Document Model Tables
const url = 'https://api.staple.io/v2/search/documents/model/tables';
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Search Document Model Tables
package main

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

func main() {

	url := "https://api.staple.io/v2/search/documents/model/tables"

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

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Search Document Model Tables
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/search/documents/model/tables")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

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

```java Search Document Model Tables
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/search/documents/model/tables")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Search Document Model Tables
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/search/documents/model/tables', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Search Document Model Tables
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/search/documents/model/tables");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Search Document Model Tables
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/search/documents/model/tables")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Model without table types

**Request**

```json
undefined
```

**Response**

```json
{
  "tableModelId": "69d6373fdc03ecfd9669fe4e",
  "tables": []
}
```

**SDK Code**

```python Model without table types
import requests

url = "https://api.staple.io/v2/search/documents/model/tables"

headers = {"x-api-key": "<apiKey>"}

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

print(response.json())
```

```javascript Model without table types
const url = 'https://api.staple.io/v2/search/documents/model/tables';
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Model without table types
package main

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

func main() {

	url := "https://api.staple.io/v2/search/documents/model/tables"

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

	req.Header.Add("x-api-key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Model without table types
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/search/documents/model/tables")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

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

```java Model without table types
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/search/documents/model/tables")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Model without table types
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/search/documents/model/tables', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Model without table types
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/search/documents/model/tables");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Model without table types
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/search/documents/model/tables")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Documents_searchDocumentModelTables_example

**Request**

```json
{
  "model": 926
}
```

**Response**

```json
{
  "tableModelId": "688c2ed087259a03a6321b86",
  "tables": [
    {
      "headers": [
        {
          "dataType": "all characters",
          "headerId": "8b76bc3d-25f7-4080-a9e2-f395e4e48018",
          "headerName": "Item Code"
        },
        {
          "dataType": "all characters",
          "headerId": "bcb01ed0-3faf-44fb-9585-78de6b16a71d",
          "headerName": "Item Description"
        },
        {
          "dataType": "all characters",
          "headerId": "df6c6b66-167f-4bbe-a6bc-7a361f22178f",
          "headerName": "Bundle Item Name"
        },
        {
          "dataType": "all characters",
          "headerId": "8a31d68e-6fbd-4f3d-a2c6-3e422cba4156",
          "headerName": "Bundle Item Quantity"
        },
        {
          "dataType": "all characters",
          "headerId": "6ca95a8c-dfc0-4a3b-99d0-af750e708dd6",
          "headerName": "Quantity"
        },
        {
          "dataType": "all characters",
          "headerId": "f91a9d5e-ebc2-402b-ae47-8e00fe7a4834",
          "headerName": "Unit Price"
        },
        {
          "dataType": "all characters",
          "headerId": "0fff003f-05fb-4019-83ad-ae909336afae",
          "headerName": "Total"
        }
      ],
      "tableName": "table 1",
      "tableTypeId": "64163822-5aac-46e1-86a4-24cb74c69f5e"
    }
  ]
}
```

**SDK Code**

```python Documents_searchDocumentModelTables_example
import requests

url = "https://api.staple.io/v2/search/documents/model/tables"

payload = { "model": 926 }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Documents_searchDocumentModelTables_example
const url = 'https://api.staple.io/v2/search/documents/model/tables';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"model":926}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Documents_searchDocumentModelTables_example
package main

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

func main() {

	url := "https://api.staple.io/v2/search/documents/model/tables"

	payload := strings.NewReader("{\n  \"model\": 926\n}")

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Documents_searchDocumentModelTables_example
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/search/documents/model/tables")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": 926\n}"

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

```java Documents_searchDocumentModelTables_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/search/documents/model/tables")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": 926\n}")
  .asString();
```

```php Documents_searchDocumentModelTables_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/search/documents/model/tables', [
  'body' => '{
  "model": 926
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Documents_searchDocumentModelTables_example
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/search/documents/model/tables");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"model\": 926\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Documents_searchDocumentModelTables_example
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["model": 926] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/search/documents/model/tables")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```