List subscriber imports

GET

/api/v3/contacts/imports

const url = 'https://api.tryletterhead.com/api/v3/contacts/imports?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/contacts/imports?api=true' \
  --header 'Authorization: Bearer <token>'

Lists your company’s audience CSV import history, newest first — each import’s status, record counts, the uploaded file name, and who started it.

This is a company-level (v3) read. Authenticate with a company API key as a Bearer token.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

page

integer

1-based page number. Minimum 1. Defaults to 1.

limit

integer

Imports per page. Minimum 1, maximum 100. Defaults to 25.

Responses

200

200 OK

application/json

object

items

Array<object>

object

uniqueId

string

status

running, finished, or errored.

string

fileName

string

nullable

startedByUserUniqueId

string

nullable

startedByName

string

nullable

startedByEmail

string

nullable

recordsTotal

integer

recordsProcessed

integer

recordsAdded

integer

recordsUpdated

integer

recordsFailed

integer

createdAt

string

updatedAt

string

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "4f2c6a9e-7b31-4e2d-9c4a-1d8f3a7b9c02",
      "status": "finished",
      "fileName": "spring-signups.csv",
      "startedByUserUniqueId": "8a1d2e3f-4b5c-6d7e-8f90-1a2b3c4d5e6f",
      "startedByName": "Jamie Rivera",
      "startedByEmail": "[email protected]",
      "recordsTotal": 3200,
      "recordsProcessed": 3200,
      "recordsAdded": 2950,
      "recordsUpdated": 210,
      "recordsFailed": 40,
      "createdAt": "2026-06-10T14:02:31+00:00",
      "updatedAt": "2026-06-10T14:06:52+00:00"
    }
  ],
  "message": "Subscriber imports retrieved.",
  "total": 1
}

Still can’t find what you need? Contact support.