---
type: api
title: Get a parameter
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v9/operation/operation-get-parameter
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v9/operation/operation-get-parameter
products:
  - Kibana
---

# Get a parameter

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

## Paths

- `GET` `/api/synthetics/params/{id}`
- `GET` `/s/{space_id}/api/synthetics/params/{id}`

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

#### Path Parameters

- `id` (string)
  The unique identifier for the parameter.

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Get a parameter from the Synthetics app.
You must have `read` privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

## Response

A successful response.

`application/json`

- `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/{id}
```

#### curl

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

## Response Examples

#### Read access

A successful response for a user with read-only permissions to get a single parameter.

```json
{
  "id": "unique-parameter-id",
  "key": "your-api-key",
  "description": "Param to use in browser monitor",
  "tags": ["authentication", "security"],
  "namespaces": ["namespace1", "namespace2"]
}
```

#### Write access

A successful response for a user with write permissions to get a single parameter.

```json
{
  "id": "unique-parameter-id",
  "key": "your-param-key",
  "description": "Param to use in browser monitor",
  "tags": ["authentication", "security"],
  "namespaces": ["namespace1", "namespace2"],
  "value": "your-param-value"
}
```