v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Data Sources

List data sources

Returns the list of all custom mapping data sources.

get/v3/mapping_data_sources

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger

Example:20

The numbers of results to return.

namestring

Unique index name

Example:my-index

Filter by name.

organizationstring

Uniquely identify an organization.

Example:mEFayXdO

Filter by organization.

workspacestring

Uniquely identify a workspace.

Example:mEFayXdO

Filter by workspace.

identifierstring

Uniquely identify a mapping data source.

Example:mEFayXdO

Filter by identifier.

Response

Will return matching data sources

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "identifier": "mEFayXdO",
      "name": "My supplier list",
      "keyProperty": "value",
      "displayProperty": "value",
      "organization": "mewlkWEKL",
      "workspace": "mewlkWEKL",
      "schema": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-07/schema#",
        "required": [
          "label"
        ],
        "properties": {
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  ]
}