Retrieve a bulk import

This endpoint returns information about an "import"—a CSV file containing a group of people or events you uploaded to using v1/imports endpoint. You can use this endpoint to check to status of imports, or find out how many rows you successfully imported from a CSV file.

get/v1/imports/{import_id}

Path parameters

import_idinteger required

The id of the import you want to lookup. This value is returned from an import that was accepted and queued for processing.

Response

Returns an import payload.

Example response

{
  "import": {
    "id": 30,
    "name": "account-object-import",
    "description": "importing accounts",
    "created_at": 1706081641,
    "updated_at": 1706081645,
    "rows_to_import": 3,
    "rows_imported": 3,
    "state": "imported",
    "type": "object",
    "data_to_process": "all",
    "people_to_process": "all",
    "object_type_id": 1,
    "error": "possible error - The specified Object Type does not exist."
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1

Sep 2, 20265da2740beeb51See the full diff
- ○
  added the media type application/json for the response with the status
  response-media-type-added

Full history