Rows

Get a set of rows from draft table

Changed on

Returns rows in the draft version of the specified table, given a set of row IDs.

post/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: hubdb
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: hubdb.rows.read

Path parameters

tableIdOrNamestring required

The unique identifier or name of the HubDB table from which to read the draft rows.

Request body

inputsstring[] required

An array of strings representing the batch input values. Each item in the array is a string.

Response

successful operation

completedAtstring date-time required

The timestamp indicating when the batch processing was completed.

linksobject

A collection of related links associated with the batch response.

requestedAtstring date-time

The timestamp indicating when the batch request was made.

startedAtstring date-time required

The timestamp indicating when the batch processing began.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.

Changes

    • info

      the security scope hubdb was added to the endpoint's security scheme oauth2

    • info

      the security scope hubdb.rows.read was removed from the endpoint's security scheme oauth2

  • 2026-03f907bc4f599cRevision changes
    • info

      the security scope hubdb.rows.read was added to the endpoint's security scheme oauth2

    • info

      the security scope hubdb-data-read was removed from the endpoint's security scheme oauth2