GET

/workbooks/{workbookId}/tables/{tableId}/columns

http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/columns

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

Access Token Required: API Key

Path Parameters

workbookIdstringrequired

The ID of the workbook that contains the table whose columns are being retrieved. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

tableIdstringrequired

The ID of the table whose columns are being retrieved. If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Query Params

nextTokenstring

This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/columns' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request GET \ 2 --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/columns' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'