List past imports

GET

/v1/contact-imports

curl --request GET \
  --url 'https://api.vocapable.com/v1/contact-imports?limit=50' \
  --header 'Authorization: Bearer <token>'

Import history, newest first.

Each row carries the consent attestation the import was submitted under - the named signer, their title, the server-stamped address and time. Those are the evidence behind every dial made against the list the import built, so the history is a record to be kept rather than a convenience.

Authorizations

• HTTPBearer

Parameters

Query Parameters

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

Filter on created_at. Comma-separated values are OR.

created_at.gte

Any of:

string

string

null

null

Filter on created_at with the gte operator.

created_at.lte

Any of:

string

string

null

null

Filter on created_at with the lte operator.

created_at.gt

Any of:

string

string

null

null

Filter on created_at with the gt operator.

created_at.lt

Any of:

string

string

null

null

Filter on created_at with the lt operator.

created_at.in

Any of:

string

string

null

null

Filter on created_at with the in operator.

status

Any of:

string

string

null

null

Filter on status. Comma-separated values are OR.

status.gte

Any of:

string

string

null

null

Filter on status with the gte operator.

status.lte

Any of:

string

string

null

null

Filter on status with the lte operator.

status.gt

Any of:

string

string

null

null

Filter on status with the gt operator.

status.lt

Any of:

string

string

null

null

Filter on status with the lt operator.

status.in

Any of:

string

string

null

null

Filter on status with the in operator.

Responses

200

Successful Response

Media typeapplication/json

CursorPage[ImportJob]

object

data

required

Data

Array<object>

ImportJob

object

id

required

Id

string

status

required

JobStatus

Lifecycle shared by the async import and export jobs.

string

Allowed values: queued running completed failed

file_uri

required

File Uri

string

column_mapping

Column Mapping

object

key

additional properties

string

target_list_id

Any of:

string

string

null

null

consent_attestation

required

ConsentAttestation

The stored attestation. signer_ip and signed_at are stamped by the API - a client-supplied timestamp is a claim, not evidence.

object

signer_name

required

Signer Name

string

>= 1 characters <= 200 characters

signer_title

required

Signer Title

string

>= 1 characters <= 200 characters

affirmation

required

Affirmation

string

>= 1 characters

consent_basis

required

ConsentBasis

CANON fact 18 - the four consent classes (docs/07-compliance.md §consent).

string

Allowed values: pewc pec ebr transactional

signer_ip

Any of:

string

string

null

null

signed_at

required

Signed At

string format: date-time

rows_accepted

required

Rows Accepted

integer

rows_rejected

required

Rows Rejected

integer

rows_skipped

Rows Skipped

integer

0

on_duplicate

On Duplicate

string

default: reject

Allowed values: reject skip update

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

next_cursor

Any of:

string

string

null

null

has_more

Has More

boolean

Example

{
  "data": [
    {
      "status": "queued",
      "consent_attestation": {
        "consent_basis": "pewc"
      },
      "rows_skipped": 0,
      "on_duplicate": "reject"
    }
  ],
  "has_more": false
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}