List columns for a warehouse table

GET

/v2/connections/tables/:tableId/columns

GET

/v2/connections/tables/:tableId/columns

$ curl https://api.sigmacomputing.com/v2/connections/tables/tableId/columns \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "name": "customer_id",
5       "type": {
6         "nullable": false,
7         "precision": 10,
8         "scale": 0,
9         "type": "integer"
10       },
11       "visibility": "included",
12       "description": "Unique identifier for each customer"
13     },
14     {
15       "name": "first_name",
16       "type": {
17         "length": 50,
18         "nullable": false,
19         "type": "string"
20       },
21       "visibility": "included",
22       "description": "Customer's first name"
23     },
24     {
25       "name": "last_name",
26       "type": {
27         "length": 50,
28         "nullable": false,
29         "type": "string"
30       },
31       "visibility": "included",
32       "description": "Customer's last name"
33     },
34     {
35       "name": "email",
36       "type": {
37         "length": 100,
38         "nullable": true,
39         "type": "string"
40       },
41       "visibility": "included",
42       "description": "Customer's email address"
43     },
44     {
45       "name": "created_at",
46       "type": {
47         "nullable": false,
48         "type": "timestamp"
49       },
50       "visibility": "included",
51       "description": "Record creation timestamp"
52     }
53   ],
54   "nextPageToken": "eyJwYWdlIjoxfQ=="
55 }

Returns column names, types, and other details for a table in a data warehouse connection.

Usage notes

Retrieve the tableId by first calling the /v2/connections/paths endpoint to discover available paths, then calling the /v2/connection/{connectionId}/lookup endpoint with the path to the desired table and using the inodeId included in the response.

Returns column names, types, and other details for a table in a data warehouse connection. ### Usage notes - Retrieve the **tableId** by first calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint to discover available paths, then calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint with the path to the desired table and using the `inodeId` included in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tableIdstringRequired

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.