Data

Read imported records.

Retrieving imported data types

get

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

Retrieves the distinct target types that currently hold imported records.

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

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

Responses

200

The request was successful. The types are returned.

application/json

string[]OptionalExample: product

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}/data/types

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

[
  "product",
  "category"
]

Searching imported records

get

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

Searches imported records of a given type with an optional search filter on the natural key, paginated.

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

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

Query parameters

typestringRequired

The target type to search.

Example: product

searchstringOptional

Optional free-text filter. This is a case-insensitive substring match on the record's natural key only — it is NOT the Emporix query language, so field selectors and operators (e.g. field:value, comparisons, boolean logic) are not supported.

Default: ""Example: SKU-1001

outcomestring · enumOptional

Optional filter by import outcome. Omit to return records of all outcomes. UPSERTED (created or updated), DELETED (removed at the source), DELETED_TARGET (removed in Emporix), FAILED, DRY_RUN (produced by a dry run).

Possible values:

pageintegerOptional

The zero-based page number.

Default: 0Example: 0

sizeintegerOptional

The page size.

Example: 20

Responses

200

The request was successful. The records are returned.

application/json

Pagination metadata for a page of results.

totalElementsintegerOptional

The total number of elements across all pages.

Example: 1250

totalPagesintegerOptional

The total number of pages.

Example: 63

numberintegerOptional

The current zero-based page number.

Example: 0

sizeintegerOptional

The page size.

Example: 20

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}/data/records

GET /importtool/{tenant}/data/records?type=product HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "totalElements": 1250,
  "totalPages": 63,
  "number": 0,
  "size": 20,
  "content": [
    {
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "streamId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "runId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "targetEntity": "emporix.customEntity",
      "targetType": "product",
      "naturalKey": "SKU-1001",
      "fields": {
        "name": "Pipe cutter",
        "sku": "SKU-1001",
        "active": true
      },
      "outcome": "UPDATED",
      "importedAt": "2026-07-27T02:03:55.000Z"
    }
  ]
}

Searching a stream's imported records

get

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

Searches the imported records produced by a specific stream with an optional search filter on the natural key, paginated.

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

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

streamIdstring · uuidRequired

The stream identifier.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query parameters

searchstringOptional

Optional free-text filter. This is a case-insensitive substring match on the record's natural key only — it is NOT the Emporix query language, so field selectors and operators (e.g. field:value, comparisons, boolean logic) are not supported.

Default: ""Example: SKU-1001

outcomestring · enumOptional

Optional filter by import outcome. Omit to return records of all outcomes. UPSERTED (created or updated), DELETED (removed at the source), DELETED_TARGET (removed in Emporix), FAILED, DRY_RUN (produced by a dry run).

Possible values:

pageintegerOptional

The zero-based page number.

Default: 0Example: 0

sizeintegerOptional

The page size.

Example: 20

Responses

200

The request was successful. The records are returned.

application/json

Pagination metadata for a page of results.

totalElementsintegerOptional

The total number of elements across all pages.

Example: 1250

totalPagesintegerOptional

The total number of pages.

Example: 63

numberintegerOptional

The current zero-based page number.

Example: 0

sizeintegerOptional

The page size.

Example: 20

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}/data/streams/{streamId}/records

GET /importtool/{tenant}/data/streams/{streamId}/records HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "totalElements": 1250,
  "totalPages": 63,
  "number": 0,
  "size": 20,
  "content": [
    {
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "streamId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "runId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "targetEntity": "emporix.customEntity",
      "targetType": "product",
      "naturalKey": "SKU-1001",
      "fields": {
        "name": "Pipe cutter",
        "sku": "SKU-1001",
        "active": true
      },
      "outcome": "UPDATED",
      "importedAt": "2026-07-27T02:03:55.000Z"
    }
  ]
}