younifyd
Menu

Get /crm/v3/imports/{import Id} /crm/v3/imports/{import Id}

Get the information on any import

GET/crm/v3/imports/{importId}

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Get /crm/v3/imports/{import Id} /crm/v3/imports/{import Id} action (under Imports).
  3. Fill in the fields below, then reference the result from later steps as {{getCrmV3ImportsImportIdCrmV3ImportsImportId.response.data}}.

Request

Path parameters

importIdinteger (int64)required

Response

Returns 200 with an object. Read it in later steps with {{getCrmV3ImportsImportIdCrmV3ImportsImportId.response.data.<field>}}.

createdAtstring (date-time)

The timestamp when the object was created, in ISO 8601 format.

idstring

The unique identifier for this import.

importNamestring

The user-provided name for this import.

importRequestJsonobject

The complete import request configuration as a JSON object.

importSourcestring

Indicates where/how the import was initiated.

One ofAPICRM_UIIMPORTMOBILE_ANDROIDMOBILE_IOSSALESFORCE

importTemplateobject
templateIdinteger (int64)required

The unique identifier for the specific saved template or previous import being referenced.

templateTypestringrequired

The classification of what type of template this represents, and what is its origin or purpose.

One ofadmin_definedprevious_importuser_file

mappedObjectTypeIdsarray<string>
metadataobject
countersobjectrequired

Summarized outcomes of each row a developer attempted to import into HubSpot.

fileIdsarray<string>required

The IDs of files uploaded in the File Manager API.

objectListsarray<object>required2 fields

The lists containing the imported objects.

optOutImportboolean

Whether or not the import is a list of people disqualified from receiving emails.

statestring

The status of the import.

One ofCANCELEDDEFERREDDONEFAILEDPROCESSINGREVERTEDSTARTED

updatedAtstring (date-time)

The timestamp when the import record was last updated, formatted as an ISO 8601 instant.

json
{
  "createdAt": "2025-01-01T00:00:00Z",
  "id": "string",
  "mappedObjectTypeIds": [
    "string"
  ],
  "metadata": {
    "counters": {},
    "fileIds": [
      "string"
    ],
    "objectLists": [
      {
        "listId": "string",
        "objectType": "string"
      }
    ]
  },
  "optOutImport": false,
  "state": "CANCELED",
  "updatedAt": "2025-01-01T00:00:00Z",
  "importName": "string",
  "importRequestJson": {},
  "importSource": "API",
  "importTemplate": {
    "templateId": 0,
    "templateType": "admin_defined"
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.