PRprivy
Imports

Get a contact import

Changed on

Retrieve a single contact import — the same row /v1/imports lists for it.

Required scope: contacts_read

get/imports/{id}

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The import's prefixed id (im_… for email imports, sim_… for SMS consent imports), as returned by /v1/imports or a contact's import_ids. The prefix selects the record type, so no channel parameter is needed. The part after the prefix is opaque — a numeric id from a Privy dashboard URL is not a valid API id and will 404, with or without the prefix; list imports to find the id.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

The import.

Example response

{
  "data": {
    "id": "im_k2R5m8Q",
    "channel": "email",
    "source": "csv",
    "status": "partial",
    "review_status": "approved",
    "requested_by": "Rita Requester"
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • fe500ab59b3bRevision changes
    • info

      endpoint added