CUcustomer
Imports

Retrieve a bulk import

Changed on

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

get/v1/imports/{import_id}

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/imports/{import_id}
  • Auth
    HTTP bearer

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

  • 63d21f880479Revision changes
    • breaking

      the ///// response's property type changed from integer to string for status

    • warning

      added the new geoset enum value to the ///// response property for the response status

    • warning

      added the new start enum value to the ///// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 5da2740beeb5Revision changes
    • info

      added the media type application/json for the response with the status