---
acl_categories:
- '@json'
- '@read'
- '@slow'
arguments:
- name: key
type: key
- name: indent
optional: true
token: INDENT
type: string
- name: newline
optional: true
token: NEWLINE
type: string
- name: space
optional: true
token: SPACE
type: string
- multiple: true
name: path
optional: true
type: string
categories:
- docs
- develop
- stack
- oss
- rs
- rc
- oss
- kubernetes
- clients
complexity: O(N) when path is evaluated to a single value where N is the size of the
value, O(N) when path is evaluated to multiple values, where N is the size of the
key
description: Gets the value at one or more paths in JSON serialized form
group: json
hidden: false
linkTitle: JSON.GET
module: JSON
railroad_diagram: /images/railroad/json.get.svg
since: 1.0.0
stack_path: docs/data-types/json
summary: Gets the value at one or more paths in JSON serialized form
syntax_fmt: "JSON.GET key [INDENT\_indent] [NEWLINE\_newline] [SPACE\_space] [path\n\
\ [path ...]]"
title: JSON.GET
---
Return the value at `path` in JSON serialized form
[Examples](#examples)
## Required arguments
key
is key to parse.
## Optional arguments
path
is JSONPath to specify. Default is root `$`. JSON.GET accepts multiple `path` arguments.
{{% alert title="Note" color="warning" %}}
When using a single JSONPath, the root of the matching values is a JSON string with a top-level **array** of serialized JSON value.
In contrast, a legacy path returns a single value.
When using multiple JSONPath arguments, the root of the matching values is a JSON string with a top-level **object**, with each object value being a top-level array of serialized JSON value.
In contrast, if all paths are legacy paths, each object value is a single serialized JSON value.
If there are multiple paths that include both legacy path and JSONPath, the returned value conforms to the JSONPath version (an array of values).
{{% /alert %}}
INDENT
sets the indentation string for nested levels.
NEWLINE
sets the string that's printed at the end of each line.
SPACE
sets the string that's put between a key and a value.
Produce pretty-formatted JSON with `redis-cli` by following this example:
{{< highlight bash >}}
~/$ redis-cli --raw
redis> JSON.GET myjsonkey INDENT "\t" NEWLINE "\n" SPACE " " path.to.value[1]
{{< / highlight >}}
## Examples
Return the value at path in JSON serialized form
Create a JSON document.
{{< highlight bash >}}
redis> JSON.SET doc $ '{"a":2, "b": 3, "nested": {"a": 4, "b": null}}'
OK
{{< / highlight >}}
With a single JSONPath (JSON array bulk string):
{{< highlight bash >}}
redis> JSON.GET doc $..b
"[3,null]"
{{< / highlight >}}
Using multiple paths with at least one JSONPath returns a JSON string with a top-level object with an array of JSON values per path:
{{< highlight bash >}}
redis> JSON.GET doc ..a $..b
"{\"$..b\":[3,null],\"..a\":[2,4]}"
{{< / highlight >}}
## Redis Software and Redis Cloud compatibility
| Redis
Software | Redis
Cloud | Notes |
|:----------------------|:-----------------|:------|
| ✅ Supported
| ✅ Flexible & Annual
✅ Free & Fixed | |
## Return information
{{< multitabs id="json-get-return-info"
tab1="RESP2"
tab2="RESP3" >}}
[Bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}): a JSON-encoded string representing the value(s) at the specified path(s).
With a single path, returns the JSON serialization of the value at that path.
With multiple paths, returns a JSON object where each key is a path and each value is an array of JSON serializations.
-tab-sep-
[Bulk string reply]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}): a JSON-encoded string with a top-level array containing the value(s) at the specified path(s).
With a single path using `$` (default in RESP3), returns a JSON array containing the serialized value.
With multiple paths, returns a JSON object where each key is a path and each value is an array of JSON serializations.
{{< /multitabs >}}
## See also
[`JSON.SET`]({{< relref "commands/json.set/" >}}) | [`JSON.MGET`]({{< relref "commands/json.mget/" >}})
## Related topics
* [RedisJSON]({{< relref "/develop/data-types/json/" >}})
* [Index and search JSON documents]({{< relref "/develop/ai/search-and-query/indexing/" >}})