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>'
{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columnCount": 123,
  "columns": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "createdByUserId": 123,
      "deleted": true,
      "description": "<string>",
      "foreignColumnId": 123,
      "foreignIds": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "foreignIdsById": {},
      "foreignIdsByName": {},
      "foreignTableId": 123,
      "id": "<string>",
      "label": "<string>",
      "name": "<string>",
      "optionCount": 123,
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "createdByUserId": 123,
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "updatedByUserId": 123
        }
      ],
      "type": "BOOLEAN",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "updatedByUserId": 123,
      "width": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "id": "<string>",
  "isOrderedManually": true,
  "label": "<string>",
  "name": "<string>",
  "published": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "useForPages": true
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
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

allowChildTables
boolean
required

Specifies whether child tables can be created

allowPublicApiAccess
boolean
required

Specifies whether the table can be read by public without authorization

columnCount
integer
required

Number of columns including deleted

columns
object[]
required

List of columns in the table

createdAt
string<date-time>
required

Timestamp at which the table is created

deleted
boolean
required
deletedAt
string<date-time>
required
dynamicMetaTags
object
required

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

enableChildTablePages
boolean
required

Specifies creation of multi-level dynamic pages using child tables

id
string
required

Id of the table

label
string
required

Label of the table

name
string
required

Name of the table

published
boolean
required
publishedAt
string<date-time>
required

Timestamp at which the table is published recently

rowCount
integer
required

Number of rows in the table

updatedAt
string<date-time>
required

Timestamp at which the table is updated recently

useForPages
boolean
required

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

createdBy
object
isOrderedManually
boolean
updatedBy
object