Skip to main content

JSON Path Extractor

The JSON Path Extractor pulls a single value out of a JSON payload using a path expression. It's the perfect follow-up to an HTTP Requests tool or any step that returns JSON: instead of handing the whole response to the next node, you extract just the field you need.

Adding it to a flow​

In the Tool node's tool picker, choose JSON Path Extractor, then set the path to the value you want.

Inputs​

ParameterDescriptionRequired
JSON PathThe path to the value to extract. Examples: data, user.name, items[0].id.Yes
Return Null on ErrorReturn null instead of raising an error when the path isn't found.No

The JSON to extract from is passed in when the tool runs — typically the output of a previous step. It can be a JSON string or an already-parsed object/array.

Path syntax​

Paths use simple dot and bracket notation:

  • data → the top-level data field
  • user.name → the name inside the user object
  • items[0].id → the id of the first item in the items array
  • results[2].address.city → nested objects and arrays combined

Outputs​

The tool returns the extracted value (as text). It's a single-output tool — the flow continues to the next node. Save the value in flow state if a later step needs it.

If the path isn't found, the tool raises an error by default — turn on Return Null on Error to get null back instead, which is handy when a field is sometimes missing.

Example​

Get the order status from an API response

  1. A Requests Get tool returns {"order": {"id": 42, "status": "shipped"}}.
  2. Add a Tool node with JSON Path Extractor and set JSON Path to order.status.
  3. The tool returns shipped, ready to use in the reply or a condition.

Tips​

  • Check array indexes carefully — items[0] is the first element; an out-of-range index isn't found.
  • Turn on Return Null on Error for optional fields so a missing value doesn't stop the flow.
  • Chain after HTTP tools to keep only the field you need instead of passing large JSON around.