---
title: "List imports"
method: GET
path: "/topics/{topicId}/imports"
tags: ["Data Import"]
---

# List imports

`GET /topics/{topicId}/imports`

## Request

- Base URL: `https://api.youscan.io/api/external`
- URL: `https://api.youscan.io/api/external/topics/{topicId}/imports`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in query parameter `apiKey`
- TypeScript: <https://skmtc.dev/youscan/apis/youscan-api/docs/topics/:topicId/imports/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of all imports for a topic, optionally filtered by status.

## Path parameters

- `topicId` integer, required

## Query parameters

- `status` 'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Aborted'

## Response `200`

Imports of the topic.

- object
  - `imports` ImportStatus[]
    - `importId` integer: Unique import identifier.
    - `name` string, nullable: Import name.
    - `totalMentions` integer: Total number of mentions in the import.
    - `savedCount` integer: Number of successfully saved mentions.
    - `failedCount` integer: Number of failed mentions.
    - `status` 'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Aborted': Current import status.
    - `createdAt` string, date-time: Creation timestamp (ISO 8601).
    - `startedAt` string, date-time, nullable: Processing start timestamp (ISO 8601).
    - `completedAt` string, date-time, nullable: Completion timestamp (ISO 8601).
    - `lastError` string, nullable: Last error message.
    - `source` string: Where the import was created from (e.g. "Api", "Ui").
    - `userEmail` string, nullable: Email of the user who created the import.
    - `userName` string, nullable: Name of the user who created the import.
    - `canShowMentions` boolean: Whether the imported mentions can be viewed in the topic.

## Other responses

- `400`: The request is invalid.
- `401`: The API key is missing or invalid.
- `404`: Topic not found or you don't have access to it.

---

[API](https://skmtc.dev/youscan/apis/youscan-api.md) - [All operations](https://skmtc.dev/youscan/apis/youscan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/youscan/apis/youscan-api/revisions/f5bef260f153?raw)