Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Import2 Imports API

Create and manage data migration (import) jobs.

Import2 Imports API is one of 2 APIs that Import2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Imports. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2.1.

Requests are made against 2 base URLs: https://www.import2.com/api/v2.1, https://www.import2.com/api/sandbox.

5 operations 4 paths 6 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1
Base URL
https://www.import2.com/api/v2.1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Import2 Imports API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication. Supply the API token as the username and any value (e.g. "X") as the password. Example: curl -u :X.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Imports 5

Create and manage data migration (import) jobs.

POST
/imports
Create an import
createImport body → 201400401422429
GET
/imports
List imports
listImports 1 param → 200401429
GET
/imports/{id}
Get import status
getImport 1 param → 200401404429
POST
/imports/{id}/payment/accept
Accept sponsored migration
acceptImportPayment 1 param → 200401404429
POST
/imports/{id}/payment/reject
Reject sponsored migration
rejectImportPayment 1 param → 200401404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ImportCreateRequest (6 properties), Import (6 properties), ImportSummary (5 properties), ImportCreated (3 properties). Each schema is shown below with its type and property counts.

ImportCreated
object
3 properties
Import
object
6 properties
ImportCreateRequest
object
6 properties 1 required
ValidationErrors
object
Map of field names to validation error messages.
ImportSummary
object
5 properties
ImportStatus
string
Lifecycle status of the import job.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

import2-imports-api-openapi.yml Raw ↑

Other APIs Import2 publishes across the network.

Import2 Tools API