List import jobs

GET/v1/api/store/{team_slug}/imports

v1Operation ID v1_public_imports_index

Lists your team's import jobs, newest first, a page at a time. Each job is one import: a service pricing CSV upload, a Printavo import, or a CSV import from the older uploader (retired in September 2026). Service pricing jobs are always completed with failed_item_count 0: a failed upload leaves no job.

You only see the jobs whose kind you are allowed to import. Use page and per_page (default 25, at most 100). There are no filters.

Imports made in the web app's current Import Portal (customers, vendors and products from CSV) are kept separately and are not listed here. They appear in the import activity feed, GET /v1/api/store/{team_slug}/source-imports/activity.

Permission

Any member who can import at least one kind of record: customers (permission to create and to update all customers), vendors (create and update vendors), products (create and update products) or service pricing (update services). When the Printavo importer is on, members who can manage settings qualify too. Each job is visible only to members with the permissions its kind needs: the ones above, and create and update services for a service pricing job that created a service. Printavo jobs also need the Printavo importer turned on for the team; Printavo jobs for records other than customers and vendors need permission to manage settings.

Path parameters

team_slugstringrequired
Your team slug, shown as Team ID next to your API key in Profile.
- Example your-team

Query parameters

pageinteger
The page to read, from 1.
- Default 1
- Minimum 1
per_pageinteger
Jobs per page.
- Default 25
- Minimum 1
- Maximum 100

Request body

This operation takes no request body.

Response

200Successful response.

dataarray of objectsrequired
Fields of each item (20)
- created_atstring (date-time)required
- display_statusstringrequired
  A status slug formatted for UI display: matches status, or is imported_with_unresolved_rows when some items succeeded and some failed.
- entity_typestringrequired
  What was imported. For CSV imports: service_pricing (the CSV type supported via API), or older uploader types (customer, vendor, simple_product, variant_product, custom_product). For Printavo imports: Printavo record types (such as customer, vendor).
- failed_item_countintegerrequired
  Items that failed. Always 0 on service pricing imports: they are all or nothing, and any error fails with 422 without creating an import job. Only Printavo imports and retired CSV uploader jobs can have failed items.
- idstringrequired
  The import job's id (a hash id).
- source_typestringrequired
  Where the data came from.
  - One of: "csv", "printavo"
- statusstringrequired
  completed, completed_with_errors and failed are final.
  - One of: "pending", "staged", "ready_to_commit", "committing", "completed", "completed_with_errors", "failed"
- success_item_countintegerrequired
  Items saved.
- total_item_countintegerrequired
  Rows (items) in the job. A service pricing job has one item: the whole price table.
- already_imported_countinteger
  Items skipped because they were imported before.
- auto_commitboolean
  True when the job saves its rows without a separate review step.
- completed_atstring (date-time) | null
  When the job reached a final status.
- display_status_labelstring | null
  A human-readable status label: "Imported with unresolved rows" when display_status is imported_with_unresolved_rows, otherwise null.
- duplicate_countinteger
  Items skipped as duplicates within the job.
- error_csv_urlstring | null
  Web app download URL for a failed-rows CSV. Null for service pricing and Printavo jobs, and for new imports. Only retired CSV uploader jobs (pre-September 2026) may have a link. Because this is a web app link that API keys cannot open, download the file via the API using GET /v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csv. Check failed_item_count to see if items failed.
- legacy_statusstring | null
  An older status word kept for the web app, such as import_success or validation_failed. Prefer status.
- source_account_refstring | null
  The connected source account, for Printavo jobs.
- target_modestring | null
  Service pricing jobs: existing_service or create. Otherwise usually null.
- unresolved_item_countinteger
  Failed items: the same number as failed_item_count.
- updated_atstring (date-time) | null
statusintegerrequired
successbooleanrequired
paginationobject
Child fields (6)
- countintegerrequired
- currentPageintegerrequired
- linksobject | array of anyrequired
  Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.
  Child fields (2)
  - nextstring (uri)
    The next page.
  - previousstring (uri)
    The previous page.
- perPageintegerrequired
- totalintegerrequired
- totalPagesintegerrequired

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, with unauthorized or user_is_not_authorized.
When
You can't import any kind of record (a plain {"message": "Insufficient Permission"} body, not the usual envelope).
Fix
Ask a team admin for permission to create and update customers, vendors, products or services.
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.
422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
When
page or per_page is not a whole number in range (validation_failed; error.fields names the field).
Fix
Send page from 1 and per_page from 1 to 100.

GETGet an import job/v1/api/store/{team_slug}/imports/{hash_id}
POSTImport a service's price table from CSV/v1/api/store/{team_slug}/imports/csv
GETList import activity/v1/api/store/{team_slug}/source-imports/activity

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/imports' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

{
  "data": [
    {
      "already_imported_count": 0,
      "auto_commit": true,
      "completed_at": "2026-11-03T09:30:02+00:00",
      "created_at": "2026-11-03T09:30:00+00:00",
      "display_status": "completed",
      "display_status_label": null,
      "duplicate_count": 0,
      "entity_type": "service_pricing",
      "error_csv_url": null,
      "failed_item_count": 0,
      "id": "L4wYdA6Rav79IZ",
      "legacy_status": "import_success",
      "source_account_ref": null,
      "source_type": "csv",
      "status": "completed",
      "success_item_count": 1,
      "target_mode": "existing_service",
      "total_item_count": 1,
      "unresolved_item_count": 0,
      "updated_at": "2026-11-03T09:30:02+00:00"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 25,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com