HUhubspot
Basic

Get the information on any import

Changed on

A complete summary of an import record, including any updates.

get/crm/imports/2026-09/{importId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/imports/2026-09/{importId}
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.import

Path parameters

importIdinteger required

The unique identifier of the import to retrieve.

Response

successful operation

createdAtstring date-time required

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

idstring required

The unique identifier for this import.

importNamestring

The user-provided name for this import.

importRequestJsonobject

The complete import request configuration as a JSON object.

importSource'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'

Indicates where/how the import was initiated.

mappedObjectTypeIdsstring[] required

An array of object type IDs that are mapped during the import.

optOutImportboolean required

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

state'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED' required

The status of the import.

updatedAtstring date-time required

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

Changes

  • 2026-098c1d8b465db8Revision changes
    • breaking

      the / response's property format changed from int32 to int64 for status

    • info

      api operation id get-/crm/imports/2026-09/{importId}_getById removed and replaced with get-/crm/imports/2026-09/{importId}_/crm/imports/v3/{importId}

    • info

      the endpoint scheme security private_apps was removed from the API