DocsAPI reference

Data tables API

A spreadsheet an agent can look things up in — an order status, a booking reference, a member number. Create a table, preview a CSV before importing it, read back row previews, and run a lookup exactly as the agent would to see what a visitor would get.

On this page
  1. Endpoints
  2. Authentication
  3. Objects returned

Endpoints#

8 operations, each with its parameters, schemas and an example request on its own page.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

DataTableResponse14 fields
  • agent_idstring (uuid) | nullrequired
  • columnsarray of objectrequired
  • descriptionstringrequired
  • idstring (uuid)required
  • is_enabledbooleanrequired
  • is_usablebooleanrequired
  • last_errorstring | nullrequired
  • last_synced_atany | nullrequired
  • max_rowsintegerrequired
  • namestringrequired
  • panels_enabledbooleanrequired
  • row_countintegerrequired
  • status_before_verifybooleanrequired
  • tool_namestringrequired
PreviewResponse4 fields
  • columnsarray of objectrequired
  • headersarray of stringrequired
  • row_countintegerrequired
  • samplearray of map of stringrequired
Message2 fields
  • messagestringrequired
  • okboolean

    Default: true

ImportResponse4 fields
  • importedintegerrequired
  • skippedintegerrequired
  • total_rowsintegerrequired
  • warningsarray of stringrequired
LookupResponse4 fields
  • fieldsobjectrequired
  • foundbooleanrequired
  • messagestringrequired
  • verifiedbooleanrequired

Something unclear or missing? Tell us and we’ll fix it.