---
title: "Retrieve a table"
url: "https://docs.unified.to/commerce/table/Retrieve_a_table"
description: "Retrieve a table with Unified's Table API (GET /commerce/{connection_id}/table/{id}). Filter by fields and raw. Supported by 9 Table integrations."
date: "2026-11-07T22:11:38.370Z"
updated: "2026-11-07T22:11:38.370Z"
---
# Retrieve a table

Updated: November 7, 2026

 GET/commerce/{connection\_id}/table/{id}

Retrieves a single CommerceTable by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need.

## Parameters

**fields**string array 

id

created\_at

updated\_at

name

number

description

is\_active

capacity

location\_id

floorplan\_name

floorplan\_identifier

layout

status

guest\_count

occupied\_at

salesorder\_ids

metadata

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

**id**string  required 

ID of the Table

## Returns

[CommerceTable](https://docs.unified.to/commerce/table/model.md)

| Response field            | Type                 | Required | Description                                                                                                                                                                                                                                              |
| ------------------------- | -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                        | string               | No       |                                                                                                                                                                                                                                                          |
| created\_at               | string (date-time)   | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                                                                 |
| updated\_at               | string (date-time)   | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                                                                 |
| name                      | string               | No       | display label of the table, e.g. "Table 1" or "Patio 4"                                                                                                                                                                                                  |
| number                    | string               | No       | human-facing table number shown on the POS (string, as some systems use alphanumeric labels)                                                                                                                                                             |
| description               | string               | No       |                                                                                                                                                                                                                                                          |
| is\_active                | boolean              | No       |                                                                                                                                                                                                                                                          |
| capacity                  | number               | No       | number of seats/guests the table is set up for                                                                                                                                                                                                           |
| location\_id              | string               | No       | reference to a commerce\_location (the restaurant/site) (reference to CommerceLocation)                                                                                                                                                                  |
| floorplan\_name           | string               | No       | floorplan, section or dining area the table belongs to                                                                                                                                                                                                   |
| floorplan\_identifier     | string               | No       | the provider's identifier of that floorplan/section                                                                                                                                                                                                      |
| layout                    | object               | No       | position and shape of the table on its floorplan                                                                                                                                                                                                         |
| layout.x                  | number               | No       | horizontal position on the floorplan, in the provider's floorplan units                                                                                                                                                                                  |
| layout.y                  | number               | No       | vertical position on the floorplan, in the provider's floorplan units                                                                                                                                                                                    |
| layout.width              | number               | No       |                                                                                                                                                                                                                                                          |
| layout.height             | number               | No       |                                                                                                                                                                                                                                                          |
| layout.rotation           | number               | No       | degrees                                                                                                                                                                                                                                                  |
| layout.shape              | enum                 | No       | Values: ROUND, SQUARE, RECTANGLE, OVAL, OTHER                                                                                                                                                                                                            |
| status                    | enum                 | No       | current occupancy Values: AVAILABLE, OCCUPIED, RESERVED, INACTIVE, OTHER                                                                                                                                                                                 |
| guest\_count              | number               | No       | number of guests currently seated                                                                                                                                                                                                                        |
| occupied\_at              | string (date-time)   | No       | when the current party was seated (earliest open order) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                         |
| salesorder\_ids           | string\[\]           | No       | open orders/checks currently on the table; references accounting\_salesorder                                                                                                                                                                             |
| metadata                  | CommerceMetadata\[\] | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].id           | string               | No       | The ID of the custom field definition (from the metadata/metadata endpoint).                                                                                                                                                                             |
| metadata\[\].value        | object               | No       | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES\_NO as true/false; MULTIPLE\_SELECT as an array of option values; otherwise a string. |
| metadata\[\].namespace    | string               | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].format       | enum                 | No       | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL                                            |
| metadata\[\].extra\_data  | object               | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].slug         | string               | No       | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.                                                                       |
| metadata\[\].description  | string               | No       |                                                                                                                                                                                                                                                          |
| metadata\[\].is\_required | boolean              | No       |                                                                                                                                                                                                                                                          |

## Errors

 Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). 

```json
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
```

| Status | Error                 | Meaning                                           |
| ------ | --------------------- | ------------------------------------------------- |
| 400    | Bad Request           | The request was malformed or failed validation.   |
| 401    | Unauthorized          | The connection is likely broken; re-authorize it. |
| 403    | Forbidden             | The connection is missing permissions or scopes.  |
| 404    | Not Found             | The requested resource does not exist.            |
| 429    | Too Many Requests     | Rate limit exceeded (see the two sources below).  |
| 500    | Internal Server Error | An unexpected error occurred.                     |
| 501    | Not Implemented       | Not supported by this integration.                |

 Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. 

### 429 Too Many Requests

A 429 has two possible sources:

* The integration's own rate limit, passed through.
* Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`.

## Code Samples

### Node.js SDK

```javascript
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.commerce.getCommerceTable({ connectionId, id, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'GET',
  url: 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

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

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

### Python

```python
import requests

url = "https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

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

url = URI("https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw=")

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

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

### cURL

```bash
curl --request GET \
  --url 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
