---
title: List ingest schemas
slug: reference/list-ingest-schemas
docTags:
createdAt: 2025-01-21T18:39:14.860Z
---
{
"id": "DwLVuefXbQaVIcR9GA3E7",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://app.amberflo.io/ingest/settings/ingest-schema",
"servers": [
{
"url": "https://app.amberflo.io/ingest/settings/ingest-schema"
}
],
"name": "List ingest schemas",
"description": "Returns a list of custom ingest schemas configured for your account.
\nIngest schemas define how to transform incoming data from custom formats (CSV, JSON) into standard meter events. Each schema contains transformation nodes that map source fields to meter event parameters like customer ID, meter name, timestamp, and dimensions.
\nUse this endpoint to browse available schemas before configuring data ingestion pipelines.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "apiKey",
"name": "X-API-KEY",
"kind": "optional",
"type": "apiKey",
"in": "header"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "Successful request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "array",
"description": "Schema configuration for parsing and transforming ingested messages with metadata and conditional application",
"customType": "ingestion.settings.IngestMessageSchema.out[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique identifier for the schema configuration used in message processing",
"example": ""
},
{
"name": "createTimeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Create time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds)",
"example": 0
},
{
"name": "updateTimeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Update time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds)",
"example": 0
},
{
"name": "schema",
"kind": "required",
"type": "object",
"description": "Schema structure definition specifying how to parse and extract data from messages",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.ExplodeNode.out",
"customType": "ingestion.schema_adapters.nodes.ExplodeNode.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Node type identifier specifying this as an explode/expansion node",
"example": "",
"default": "explode"
},
{
"name": "sourceName",
"kind": "optional",
"type": "string",
"description": "Field name or path in the source message containing the array or object to explode",
"example": ""
},
{
"name": "subComponents",
"kind": "optional",
"type": "object",
"description": "Array of schema extractor nodes defining how to process each exploded element",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.SchemaExtractorNode.out",
"customType": "ingestion.schema_adapters.nodes.SchemaExtractorNode.out[]",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "ingestion.schema_adapters.nodes.CustomerIdNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.CustomerIdNode.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Node type identifier specifying this as a customer ID extraction node",
"example": "",
"default": "customer_id"
},
{
"name": "sourceName",
"kind": "optional",
"type": "string",
"description": "Field name or path in the source message from which to extract the customer ID",
"example": ""
}
]
},
{
"name": "ingestion.schema_adapters.nodes.DimensionNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.DimensionNode.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Node type identifier specifying this as a dimension extraction node",
"example": "",
"default": "dimension"
},
{
"name": "sourceName",
"kind": "optional",
"type": "string",
"description": "Field name or path in the source message from which to extract the dimension value",
"example": ""
},
{
"name": "targetName",
"kind": "optional",
"type": "string",
"description": "Target dimension name to assign the extracted value in the resulting meter event",
"example": ""
}
]
},
{
"name": "ingestion.schema_adapters.nodes.EventTimeNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.EventTimeNode.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Node type identifier specifying this as an event time extraction node",
"example": "",
"default": "event_time"
},
{
"name": "timeFormat",
"kind": "optional",
"type": "string",
"description": "Time format specification for parsing the source timestamp value",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.TimeFormat.out",
"customType": "ingestion.schema_adapters.nodes.TimeFormat.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "sourceName",
"kind": "optional",
"type": "string",
"description": "Field name or path in the source message from which to extract the timestamp",
"example": ""
}
]
},
{
"name": "ingestion.schema_adapters.nodes.ExplodeNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.ExplodeNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "ingestion.schema_adapters.nodes.ForkNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.ForkNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "ingestion.schema_adapters.nodes.MeterApiNameNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.MeterApiNameNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "ingestion.schema_adapters.nodes.ValueNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.ValueNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "ingestion.schema_adapters.nodes.SameElementArrayNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.SameElementArrayNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "ingestion.schema_adapters.nodes.UniqueIdNode.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.nodes.UniqueIdNode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "condition",
"kind": "optional",
"type": "object",
"description": "Optional condition for applying schema. Used to evaluate if schema should be applied",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.MatchCondition.out",
"customType": "ingestion.schema_adapters.conditions.MatchCondition.out",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "ingestion.schema_adapters.conditions.NotCondition.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.NotCondition.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Condition type identifier specifying this as a negation condition",
"example": "",
"default": "not"
},
{
"name": "condition",
"kind": "required",
"type": "object",
"description": "The nested condition whose result will be inverted by this negation operator",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.MatchCondition.out",
"customType": "ingestion.schema_adapters.conditions.MatchCondition.out",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "ingestion.schema_adapters.conditions.NotCondition.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.NotCondition.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Circular-Reference"
}
]
},
{
"name": "ingestion.schema_adapters.conditions.ValidIdentifierCondition.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.ValidIdentifierCondition.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Condition type identifier specifying this as a valid identifier validation condition",
"example": "",
"default": "valid_identifier"
},
{
"name": "fieldName",
"kind": "required",
"type": "string",
"description": "Name of the field in the message to validate against the list of valid values",
"example": ""
},
{
"name": "validValues",
"kind": "required",
"type": "array",
"description": "Array of acceptable string values that the specified field must match for condition to be true",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
]
}
]
},
{
"name": "ingestion.schema_adapters.conditions.ValidIdentifierCondition.out",
"description": "",
"modelRef": "#/components/schemas/ingestion.schema_adapters.conditions.ValidIdentifierCondition.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Condition type identifier specifying this as a valid identifier validation condition",
"example": "",
"default": "valid_identifier"
},
{
"name": "fieldName",
"kind": "required",
"type": "string",
"description": "Name of the field in the message to validate against the list of valid values",
"example": ""
},
{
"name": "validValues",
"kind": "required",
"type": "array",
"description": "Array of acceptable string values that the specified field must match for condition to be true",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
]
},
{
"name": "autoDetectable",
"kind": "optional",
"type": "boolean",
"description": "Whether the schema can be used in schema auto-detection. Can only be true if schema has condition",
"example": ""
}
],
"modelRef": "#/components/schemas/ingestion.settings.IngestMessageSchema.out",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "9uZT7Qz6q8sB4RJbdpSKs",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://app.amberflo.io/ingest/settings/ingest-schema \\\n --header 'accept: application/json'"
},
{
"id": "lhPvMo3uuk9_0CT-iigt-",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/ingest/settings/ingest-schema\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "2qaPDKXgaknIuYtbZojhl",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/ingest/settings/ingest-schema\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "oEaYR1v-he7cumFLtlt0A",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/ingest/settings/ingest-schema\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "9uZT7Qz6q8sB4RJbdpSKs"
},
"results": {
"languages": [
{
"id": "TQtTMzK1Z0pHkVYwqJf_J",
"language": "200",
"code": "// Successful request\n[\n {\n \"id\": \"\",\n \"createTimeInSeconds\": \"\",\n \"updateTimeInSeconds\": \"\",\n \"schema\": {\n \"type\": \"\",\n \"sourceName\": \"\",\n \"subComponents\": {}\n },\n \"condition\": {},\n \"autoDetectable\": false\n }\n]"
}
],
"selectedLanguageId": "TQtTMzK1Z0pHkVYwqJf_J"
}
},
"children": [
{
"text": "",
"id": "P0BJgnO0z9-0QP3bGJ1dt"
}
]
}