---
title: "List parameters"
method: GET
path: "/parameter"
tags: ["Parameter"]
---

# List parameters

`GET /parameter`

List parameters by NRN.

## Query parameters

- `offset` integer
- `limit` integer
- `nrn` string, required

## Response `200`

The operation was successful.

- ParameterList
  - `paging` object
    - `total` integer, required — The total number of results matching the query.
    - `offset` integer, required — The starting point for pagination. Defaults to 0 if not provided.
    - `limit` integer, required — The maximum number of results to return per page. The maximum allowed value is 200.
  - `results` ParameterResponse[]
    - `id` integer, required — A system-wide unique ID for the parameter.
    - `name` string, required — The name of the parameter.
    - `nrn` string, required — The NRN of the application which the parameter belongs to.
    - `type` 'environment' | ' file', required — The type of the parameter.
    - `encoding` 'plaintext' | ' base64', required — The encoding of the parameter value.
    - `variable` string — The name of the environment variable. Required when `type` is `environment`.
    - `destination_path` string — The full file path. Required when `type` is `file`.
    - `secret` true | false, required — Indicates whether the value is a secret. `true` if it is a secret, `false` otherwise.
    - `read_only` true | false, required — Indicates whether the value is read-only. `true` if it is read-only, `false` otherwise.
    - `version_id` integer, required — A system-wide unique ID for the parameter version.
    - `values` ParameterValue[], required
      - `id` integer, required — A system-wide unique ID for the value.
      - `nrn` string, required — The NRN of the application which the parameter belongs to.
      - `created_at` string, date-time, required — The ISO-8601 UTC timestamp of when the parameter value was created.
      - `value` string, nullable — The value of the parameter.<br><br> > **Note:** If `show_secret_values` is set to `true`, the value is **only visible to users with the required permission**. See [Accessing secret values](/docs/parameters/secret-visibility) for more details.
      - `location` string — The file path. Applicable only for files; null otherwise. Also null for secrets.
      - `external` object, nullable — Object containing the external ID and engine of the value. > **Note:** Applicable only for parameters stored in your own (external) infrastructure.
        - `id` string, required — The external ID of the value.
        - `engine` string, required — The engine of the value. > **Note:** At the moment, only `hcp_vault` is supported.
      - `dimensions` object — The dimensions of the value.

## Other responses

- `4XX` — Client error responses due to invalid input or missing parameters.
- `5XX` — Server error responses indicating an issue on the API side.

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)