Configurations

Read import configurations.

Retrieving all import configurations

get

This functionality is in preview mode - some of the features may not be fully operational yet.

Retrieves all import configurations defined for the tenant.

Required scopes

This endpoint requires the following scopes:

• : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

Responses

200

The request was successful. The configurations are returned.

application/json

An import configuration grouping one or more streams.

idstring · uuidOptional

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

tenantstringOptional

The owning tenant.

Example: mytenant

namestringOptional

The configuration name.

Example: ERP product master import

descriptionstringOptional

A free-text description.

Example: Nightly import of product master data from the ERP system.

sourceConnIdstring · uuidOptional

The default source connection for the configuration's streams.

Example: 550e8400-e29b-41d4-a716-446655440000

deltaEnabledbooleanOptional

Whether delta (incremental) runs are enabled.

Example: true

enabledbooleanOptional

Whether the configuration is active.

Example: true

createdAtstring · date-timeOptional

When the configuration was created.

Example: 2026-07-01T10:15:30.000Z

updatedAtstring · date-timeOptional

When the configuration was last updated.

Example: 2026-07-20T08:00:00.000Z

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

get/importtool/{tenant}/configs

HTTPcURLJavaScriptPython

GET /importtool/{tenant}/configs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "tenant": "mytenant",
    "name": "ERP product master import",
    "description": "Nightly import of product master data from the ERP system.",
    "sourceConnId": "550e8400-e29b-41d4-a716-446655440000",
    "deltaEnabled": true,
    "enabled": true,
    "createdAt": "2026-07-01T10:15:30.000Z",
    "updatedAt": "2026-07-20T08:00:00.000Z"
  }
]

Retrieving an import configuration

get

This functionality is in preview mode - some of the features may not be fully operational yet.

Retrieves a single import configuration by its identifier.

Required scopes

This endpoint requires the following scopes:

• : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

idstring · uuidRequired

The resource identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Responses

200

The request was successful. The configuration is returned.

application/json

An import configuration grouping one or more streams.

idstring · uuidOptional

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

tenantstringOptional

The owning tenant.

Example: mytenant

namestringOptional

The configuration name.

Example: ERP product master import

descriptionstringOptional

A free-text description.

Example: Nightly import of product master data from the ERP system.

sourceConnIdstring · uuidOptional

The default source connection for the configuration's streams.

Example: 550e8400-e29b-41d4-a716-446655440000

deltaEnabledbooleanOptional

Whether delta (incremental) runs are enabled.

Example: true

enabledbooleanOptional

Whether the configuration is active.

Example: true

createdAtstring · date-timeOptional

When the configuration was created.

Example: 2026-07-01T10:15:30.000Z

updatedAtstring · date-timeOptional

When the configuration was last updated.

Example: 2026-07-20T08:00:00.000Z

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Internal Service Error occurred.

application/json

get/importtool/{tenant}/configs/{id}

HTTPcURLJavaScriptPython

GET /importtool/{tenant}/configs/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "tenant": "mytenant",
  "name": "ERP product master import",
  "description": "Nightly import of product master data from the ERP system.",
  "sourceConnId": "550e8400-e29b-41d4-a716-446655440000",
  "deltaEnabled": true,
  "enabled": true,
  "createdAt": "2026-07-01T10:15:30.000Z",
  "updatedAt": "2026-07-20T08:00:00.000Z"
}