Import

List mappers

Retrieve a paginated list of mappers for the authenticated organization. Supports filtering by application and name.

get/v1/import/mappers

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/import/mappers
  • Auth: API key in header X-Api-Key

Query parameters

field'id' | 'createdAt' | 'updatedAt' | 'name' | 'createdAt' | 'updatedAt' required
order'asc' | 'desc' required
currentPageinteger

1-based page index.

pageSizeinteger

Number of items per page.

Response

Mappers retrieved successfully

totalinteger required

Total count of items matching the query

Example response

{
  "data": [
    {
      "application": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Shopify product import",
      "type": "file",
      "url": "https://example.com/catalog/products.csv",
      "cronFrequency": "0 2 * * *",
      "csvHasHeader": true,
      "rows": [
        {
          "type": "path",
          "source": "$.product.brand",
          "destination": "brand"
        }
      ],
      "sourceStructure": {
        "format": "csv",
        "columns": [
          "gtin",
          "titre",
          "prixttc"
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.