Workbench

Import Workbench From Crm

Pull records out of a connected CRM into this table. READS THEIR SYSTEM.

No credit is charged for the import itself, but it reaches into the customer's own CRM, which is why it needs the same grant as the other operations that do - a customer can hand out "read my workbench" without handing out "read my Salesforce".

limit caps what lands, and it matters twice: once for the CRM's own API quota, and again if this table auto-enriches, because every imported row is then a row that spends.

crm_provider and object_type are the app's legacy aliases for provider_type and entity_type. They are mirrored because the app still accepts them, not because new code should send them.

post/workbench/tables/{table_id}/import/crm

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/import/crm
  • Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

connection_idstring nullable

Which CRM connection to read.

provider_typestring nullable

CRM provider key, e.g. 'hubspot'.

filtersobject nullable
limitinteger
raw_source_column_idinteger nullable
entity_type'contact' | 'company' nullable
crm_providerstring nullable

Legacy alias of provider_type.

object_typestring nullable

Legacy alias of entity_type (plural form).

Response

Successful Response

dataEnrichmentPayload required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

Changes

No recorded changes to this operation across all 2 revisions of this API.