List contact imports | Resend API (unofficial showcase)

4 parameters

statusstringoptional

Filter imports by status: `queued`, `in_progress`, `completed`, or `failed`.

Allowed:queuedin_progresscompletedfailed

limitintegeroptional

Number of imports to return. Must be between 1 and 100.

afterstringoptional

Return imports after this cursor.

beforestringoptional

Return imports before this cursor.

1 status code

200Returns a paginated response containing contact import records, a `has_more` indicator, and the response object type.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing contact imports.

Error handling

status must be one of queued, in_progress, completed, or failed. limit must be between 1 and 100; use after or before to provide a cursor.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.imports.list({
  status: "example",
  limit: 20,
  after: "example",
  before: "example",
});

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "contact_import",
      "id": "479e3145-dd38-476b-932c-529ceb705947",
      "status": "completed",
      "created_at": "2023-10-06 23:47:56.678+00",
      "completed_at": "2023-10-06 23:50:56.678+00",
      "counts": {
        "total": 100,
        "created": 80,
        "updated": 10,
        "skipped": 5,
        "failed": 5
      }
    }
  ]
}

Request

Response

Errors