---
type: api
title: Get parameters
description: Get a list of all parameters. You must have `read` privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-parameters
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-parameters
products:
  - Kibana
---

# Get parameters

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/synthetics/params`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#basicauth)

## Description

Get a list of all parameters. You must have `read` privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

## Response

A successful response.

`application/json`

Type: `[] object`

- `description` (string)
  The description of the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
- `id` (string)
  The unique identifier of the parameter.
- `key` (string)
  The key of the parameter.
- `namespaces` ([] string)
  The namespaces associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
- `tags` ([] string)
  An array of tags associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
- `value` (string)
  The value associated with the parameter. It will be included in the response if the user has write permissions.
## Code Examples

#### Console

```console
GET /api/synthetics/params
```

#### curl

```curl
curl -X GET "https://{kibana_url}/api/synthetics/params"
```

## Response Examples

#### Read access

A successful response for a user with read-only permissions to get a list of parameters.

```json
[
  {
    "id": "param1-id",
    "key": "param1",
    "description": "Description for param1",
    "tags": ["tag1", "tag2"],
    "namespaces": ["namespace1"]
  },
  {
    "id": "param2-id",
    "key": "param2",
    "description": "Description for param2",
    "tags": ["tag3"],
    "namespaces": ["namespace2"]
  }
]
```

#### Write access

A successful response for a user with write permissions to get a list of parameters.

```json
[
  {
    "id": "param1-id",
    "key": "param1",
    "description": "Description for param1",
    "tags": ["tag1", "tag2"],
    "namespaces": ["namespace1"],
    "value": "value1"
  },
  {
    "id": "param2-id",
    "key": "param2",
    "description": "Description for param2",
    "tags": ["tag3"],
    "namespaces": ["namespace2"],
    "value": "value2"
  }
]
```