List import activity
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/csv-imports/v1-source-imports-activity-index.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
GET/
Lists the Import Portal's import activity, newest first unless you ask for sort=oldest, with paging by cursor. Pass meta.next_cursor as cursor to read the next page. The answer is plain JSON, {data, meta}, not the usual {success, status, data} envelope.
CSV events are the Import Portal's CSV imports of customers, vendors and products, once finished: import_completed, import_partial_completed or import_failed, with counts. You see each kind only if you can import it. Service pricing uploads are not in this feed; list them with GET /v1/api/store/{team_slug}/imports.
Path parameters
Your team slug, shown as Team ID next to your API key in Profile.
- Example
your-team
- Example
Query parameters
sourcestring- One of:
"all","csv" - Default
"all" - Example
all
- One of:
sortstring- One of:
"newest","oldest" - Default
"newest" - Example
newest
- One of:
limitintegerEvents per page. Below 1 or not a number reads as 50; above 100 reads as 100.
- Default
50 - Minimum 1
- Maximum 100
- Default
cursorstringThe previous page's
meta.next_cursor. An invalid cursor is ignored, and you get the first page.
Request body
This operation takes no request body.
Response
200A page of events.
Fields of each item (9)
sourceTypestring- Always
"csv"
- Always
countsobjectEntity and source-row counts:
entity_countandsource_row_count, thensubmitted_,imported_,failed_,not_processed_,unresolved_,removed_,already_existing_,preflight_blocked_,excluded_andpending_each withentity_countandsource_row_count. Left out when the import could not be verified.detailstringFor example "2 imported · 0 need attention".
entityTypestring- One of:
"customer","vendor","simple_product","variant_product"
- One of:
idstringcsv:and the import'sreceipt_id.messagestring"CSV import completed", "Some entries were imported" or "No entries were imported" ("CSV import could not be verified" when YoPrint stopped the import for a failed integrity check).
receipt_idstringThe Import Portal CSV import's id (
csv-...).timestampstring (date-time)When the import finished.
typestring- One of:
"import_completed","import_partial_completed","import_failed"
- One of:
Child fields (3)
has_morebooleanlimitintegernext_cursorstring | nullNull on the last page.
Errors
401The API key is missing or wrong (
unauthenticated).403You are not allowed to do this.
api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only{"message": "Insufficient Permission"}. Other refusals use the error envelope, withunauthorizedoruser_is_not_authorized.- When
- You can't import anything (a plain
{"message": "Insufficient Permission"}body, not the usual envelope). - Fix
- Ask a team admin.
404Not found.
page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's.code: null, with a message that starts "No query results for": there is no record with that id.
Notes
- Unrecognized
sourceorsortvalues are treated as their defaults.
Related
- GETList import jobs
/v1/ api/ store/ {team_slug}/ imports
