PRprivy
Imports

List contact imports

Changed on

Retrieve a paginated list of your contact imports — CSV uploads and connected-provider syncs — most recently requested first. Each row mirrors the dashboard's import history: type, processing status, contact counts, who requested it, when, and its review status.

channel selects which universe is listed: email (the default — contact imports and provider syncs) or sms (SMS consent imports, a separate review pipeline). The two are different record types with per-channel status/review_status vocabularies and count keys; rows state their channel.

Required scope: contacts_read

get/imports

Request

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

Query parameters

pageinteger

Page number (starts at 1).

per_pageinteger

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

channel'email' | 'sms'

Which import universe to list. Defaults to email.

statusstring

Filter by processing status. Email values: pending, partial, successful, failed. Not available on channel=sms for merchant tokens (status is omitted from their SMS rows) — the filter returns a 422 there.

review_statusstring

Filter by approval state. Email values: NA, exempt, pending, approving, approved, auto_approved, partially_approved, rejected. SMS values: pending, approved, rejected.

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

A paginated list of imports.

Example response

{
  "data": [
    {
      "id": "im_k2R5m8Q",
      "channel": "email",
      "source": "csv",
      "status": "partial",
      "review_status": "approved",
      "requested_by": "Rita Requester"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6
  }
}

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