---
title: "JSON Object Methods"
component: "gsql-ref"
version: "4.3"
module: "querying"
html_url: "/gsql-ref/4.3/querying/func/json-object-methods"
canonical_url: "https://www.tigergraph.com/docs/gsql-ref/4.3/querying/func/json-object-methods"
markdown_url: "https://www.tigergraph.com/docs/gsql-ref/4.3/querying/func/json-object-methods.md"
---

[View as HTML](https://www.tigergraph.com/docs/gsql-ref/4.3/querying/func/json-object-methods)

# JSON Object Methods

This page lists the methods of a JSON object variable. Methods can be accessed using the dot(`.`) operator.

## `containsKey()`

### Syntax

`jsonobject.containsKey( keyStr )`

### Description

Returns a boolean value indicating whether the JSON object contains a specified key.

### Return type

`BOOL`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | A string. | `STRING` |

### Example

If we have the following JSON object represented by the variable `han`:

```json
{
    "name": "Han Solo",
    "age": "39",
    "occupation": "mercenary"
}
```

Then:

```text
han.containsKey("name") -> true
han.containsKey("isJedi") -> false
```

## `getBool()`

### Syntax

`jsonobject.getBool( keyStr )`

### Description

Returns the boolean value associated with a specified key. If the key provided is associated with a non-boolean value, the function will raise a runtime error.

### Return type

`BOOL`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |

### Example

If we have the following JSON object represented by the variable `han`:

```json
{
    "name": "Han Solo",
    "age": 39,
    "occupation": "mercenary",
    "isJedi": false
}
```

Then:

```text
han.getBool("isJedi") -> false
```

## `getDouble()`

### Syntax

`jsonobject.getDouble( keyStr )`

### Description

Returns the double value associated with a specified key. If the key provided is associated with a non-double value, the function will raise a runtime error.

### Return type

`DOUBLE`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |

## `getInt()`

### Syntax

`jsonobject.getInt( keyStr )`

### Description

Returns the integer value associated with a specified key. If the key provided is associated with a non-int value, the function will raise a runtime error.

### Return type

`INT`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |

## `getJsonArray()`

### Syntax

`jsonobject.getJsonArray( keyStr )`

### Description

Returns the JSON array value associated with a specified key. If the key provided is associated with a value whose type is not JSON array, the function will raise a runtime error.

### Return type

`JSONARRAY`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |

## `getJsonObject()`

### Syntax

`jsonobject.getJsonObject( keyStr )`

### Description

Returns the value associated with a specified key. If the key provided is associated with value whose type is not JSON object, the function will raise a runtime error.

### Return type

`JSONOBJECT`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |

## `getString()`

### Syntax

`jsonobject.getString( keyStr )`

### Description

Returns the string value associated with a specified key. If the key provided is associated with a non-string value, the function will raise a runtime error.

### Return type

`STRING`

### Parameters

| Parameter | Description | Data type |
| --- | --- | --- |
| `keyStr` | The key whose value to return | `STRING` |
