---
title: "Get imported rows for an embed file"
method: GET
path: "/v1/embeds/{embed_id}/imported-rows"
tags: ["Importer Embeds"]
---

# Get imported rows for an embed file

`GET /v1/embeds/{embed_id}/imported-rows`

## Request

- Base URL: `https://api.oneschema.co`
- URL: `https://api.oneschema.co/v1/embeds/{embed_id}/imported-rows`
- Auth: API key in header `X-API-KEY`

Retrieve validated data from an embed file with optional pagination.

## Path parameters

- `embed_id` integer, required

## Query parameters

- `start_row` integer
- `count` integer

## Response `200`

200

- ImportedRowsResponse
  - `template_key` string
  - `workspace_id` integer
  - `workspace_metadata` EmptyResponse
  - `studio_project_metadata` StudioProjectMetadata: A JSON object containing any custom metadata associated with the originating project, if the export originated from a project that has custom metadata configured.
  - `studio_folder_metadata` StudioFolderMetadata: Merged custom metadata of the Studio folders containing the project, from the root folder down; keys set on a child folder override the same keys on its parent folders. Omitted when empty.
  - `studio_metadata` StudioMetadata: Merged custom metadata of the Studio folders containing the project and the project's own custom metadata, with project keys taking precedence. Omitted when empty. Only sent when the corresponding feature flag is enabled for your org.
  - `sheet_id` integer
  - `sheet_metadata` SheetMetadata
    - `original_file_name` string
  - `columns` ImportedRowsColumn[]
    - `sheet_column_name` string
    - `template_column_name` string
    - `template_column_key` string
  - `count` integer
  - `records` ImportedRowRecord[]
    - `account_name` string
    - `first_name` string
    - `last_name` string
    - `owner` string
    - `lead_source` string
    - `date_added` string
    - `country_code` string
    - `mailing_address` string
    - `timezone` string
    - `market_segment` string
    - `title` string
    - `email_opt_out` string
    - `primary_phone` string
    - `average_spend` string
  - `error_records` EmptyResponse[]

## Other responses

- `400`: The request parameters are invalid, or the embed has not been imported, its import failed, or its import has not completed (pending metadata webhook imports are not rejected).
- `403`: The embed does not exist or does not belong to the API key's organization.

---

[API](https://skmtc.dev/oneschema/apis/importer-embeds.md) - [All operations](https://skmtc.dev/oneschema/apis/importer-embeds/llms.txt) - [OpenAPI document](https://skmtc.dev/oneschema/apis/importer-embeds/revisions/b00b6b778c45?raw)
