Zum Hauptinhalt springen
GET
/
cms
/
v3
/
hubdb
/
tables
/
{tableIdOrName}
Get details of a published table
curl --request GET \
  --url https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName} \
  --header 'Authorization: Bearer <token>'
{
  "dynamicMetaTags": {},
  "updatedBy": {
    "firstName": "<string>",
    "lastName": "<string>",
    "id": "<string>",
    "email": "<string>"
  },
  "allowPublicApiAccess": true,
  "useForPages": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "columns": [
    {
      "createdByUserId": 123,
      "foreignTableId": 123,
      "updatedBy": {
        "firstName": "<string>",
        "lastName": "<string>",
        "id": "<string>",
        "email": "<string>"
      },
      "description": "<string>",
      "label": "<string>",
      "updatedByUserId": 123,
      "type": "NULL",
      "optionCount": 123,
      "foreignIds": [
        {
          "name": "<string>",
          "id": "<string>",
          "type": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "deleted": true,
      "createdBy": {
        "firstName": "<string>",
        "lastName": "<string>",
        "id": "<string>",
        "email": "<string>"
      },
      "name": "<string>",
      "options": [
        {
          "createdByUserId": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedBy": {
            "firstName": "<string>",
            "lastName": "<string>",
            "id": "<string>",
            "email": "<string>"
          },
          "createdBy": {
            "firstName": "<string>",
            "lastName": "<string>",
            "id": "<string>",
            "email": "<string>"
          },
          "name": "",
          "id": "",
          "label": "",
          "updatedByUserId": 123,
          "type": "",
          "order": 123,
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "width": 123,
      "id": "<string>",
      "foreignIdsById": {},
      "foreignColumnId": 123,
      "foreignIdsByName": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "label": "<string>",
  "published": true,
  "columnCount": 123,
  "allowChildTables": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "deleted": true,
  "createdBy": {
    "firstName": "<string>",
    "lastName": "<string>",
    "id": "<string>",
    "email": "<string>"
  },
  "name": "<string>",
  "enableChildTablePages": true,
  "id": "<string>",
  "rowCount": 123,
  "isOrderedManually": true,
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • hubdb

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
tableIdOrName
string
required

The ID or name of the table to return.

Query Parameters

​
archived
boolean

Set this to true to return details for an archived table. Defaults to false.

​
includeForeignIds
boolean

Set this to true to populate foreign ID values in the result.

​
isGetLocalizedSchema
boolean

Response

successful operation

​
label
string
required

Label of the table

​
deletedAt
string<date-time>
required
​
name
string
required

Name of the table

​
dynamicMetaTags
object

Specifies the key value pairs of the metadata fields with the associated column IDs.

​
updatedBy
object
​
allowPublicApiAccess
boolean

Specifies whether the table can be read by public without authorization

​
useForPages
boolean

Specifies whether the table can be used for creation of dynamic pages

​
publishedAt
string<date-time>

Timestamp at which the table is published recently

​
columns
object[]

List of columns in the table

​
published
boolean
​
columnCount
integer

Number of columns including deleted

​
allowChildTables
boolean

Specifies whether child tables can be created

​
createdAt
string<date-time>

Timestamp at which the table is created

​
deleted
boolean
​
createdBy
object
​
enableChildTablePages
boolean

Specifies creation of multi-level dynamic pages using child tables

​
id
string

Id of the table

​
rowCount
integer

Number of rows in the table

​
isOrderedManually
boolean
​
updatedAt
string<date-time>

Timestamp at which the table is updated recently

⌘I