---
id: parameter-list
title: "List parameters"
description: "List parameters by NRN."
sidebar_label: "List parameters"
hide_title: true
hide_table_of_contents: true
api: eJzdWWFv47gR/SsDftoNFEdxsodC1z0g3bu2KYpcsElwhyaBTUtjm3cUqSUpZ72G/nsxpGRLltab3N22RYHEcURy5nFm3nCG2rAMbWpE4YRWLGH/FNZBwQ3P0aGxMFvD1furEYvY7iFL7jdM0OwPJZo1i5jiObKE6fncomMRs+kSc86SDXPrgkaEcrhAwyKWCyXyMmdJHLEM57yUjiVxFe3huF0iWMeNE2oBhRbKwVwbKPhCKE5zRvB9WG3BaYhBzEFpB4XRK5FhRojxI88LiV78MGApcnEQ7yCunH+kLYAq8xka0HMwaBskBl1pFBTowWIHx5kHUutWRrGoi6qv6ur9FTwtRboEt8SdX2CGUqsFKSQFBj+UwmDGEmdKHNiOdUaoBe1mi4Vps+BKfPLGfHua8DTVpXJvxwnhswVP8e1ZwotCijTMOWfVY8R0gcb/f5mxZBcUiRSWLOn4guKDXTcD7DFiFtPSCLf2gTNDbtBclG7JkvtHEmnQFlpZtIR4HMf0p2+KrWJ44hZsmaZo7byUZIBUK4fK0cIW4pNfLK3etOxRGBLjRNDlo2nRspOe/YKp61j0fhfVTbQ47bikfXWlhcdDMd/fjJ87EEA5d+mSQp7c7cOiF0ANni+T62vyqTbGIIhAD5aM40EYL6IPtFdwKfUTZrDiskQQFsZx3AE2juOqqnxEkcAWPG4MJ4oJh7n9ksdF1qSIqKapnx0xVKnOKGR8TBsMC3k20UqSdA/M0hc0Vmg1EVk/TkT2jCC5ALu2DvPjJ5EhlEp8KBEuv/dO66SCzv5Px2fnVZPd9tk/5AuaSR74vEh2rbWEG/EJKX2QNZ4lmBJXLbfFyGfkst+XoGpPJZuWHFQrYbTKKUEMcnFdDNtgf5eoKKrv9wTCXEgkLzvhvL6tjIkXULXCpoOrkJy8/3EYVbOmhyxE/yF8bcEw4xa/OR/Gt8VVUegawWfyN8RNyxzQSBnB+5pP8LREBVMSOSXKTlvTp6P6gHV1EpoUnI6F5yCYl1J60wOtOaCP5gRFNWV34mdaS+SqJ/9SZRRTaEmYW2Kg3DbrcAiSRjCl83ZKuVK49kgE0zmXFqegafmTsKEQCA7yh7Qff6za+eN3AyNRxySqj2w79BJorSz2B2YsqMX2MledveokeiB396Nhjx221kouaWUfbcCmukDbYs+BA8Bn/tQgd5hNuPtKmXxL514W/5/PtS3bPAvo5c2Px3/6Jj6Fu9t34ESO1vG8IOyetANpztd6tRpCPNcmJ20s4w6PSURnG+N4fHocnx7H49s4TvzPv1gTUkMYVSllyHqhcu5jDjB6x8OfZ+Y7+n1Q38HR0ZV2mBwdweUcpnapnyYhDUxCMPo8ZNFRfRN4GXV5e3REzISVsGImqTiE0lLz9SRccGATm1QX5cISe46ORnCDCPcXvhCmkyIorRnw+Ook06k92bVtJ2H82KsRUrj1ax+EuTYIGToupB09qD2DxmQ/qYPbn5mad1n5IoQM7cpvkfTRsP0WyPStHAQX0urwkCYFrLYTpTToWxiHRnVK7S2JD/vzRz8NqFvgQjVldiOPSMlVBqgWQm1dHugJ5OeWo4f21eqardPkLaFgrUsD+knBq0bNaxBqbrh1pkxdaTCYvJd9AorP5ZyBeqG1iw70oUJhVxvVqyYim5yOz0Kx4hUPKxk2TZcEF86P5pqO+CjYZ7pMi8mK2otAhrIotCFOP6iD+LbLmK/rM5GjougfLOH7eHfzezbZ6th06rmEZbhCqYu6uvN50KxZwu5uAoZ+GRWyy/Dg+7q37Q5vu2O6bqGhKmLnP//cN/o7KaisQmO0gW2fDFnps4RQKy4FxVlROjrdfG6gBm8bii/qjg8didZxV9p3OvMZl/BQq4fW8sVAlLZmf/mE/Pvt7TWEFZDqjNJdYdCicg1FbYGpmIsU0rY9XuFoMYrgPI7p45Q+zujj/HXHwecx9atpF8tn0tcF5JwacDymgsnzO+jyuNySO6D6a6GN+IQ2YEOzQgNzLiSxuRO+M55NyIhIXm7M9gwQMyNwHsGyzLnaIWnN2tbeHpzvYGprPLC/8MxXw2jdA6MHd4qXbukhZw+sa5z2bILYePTLILNM0Fcum7MD+EyXbgerq+e2PsbQOn+o51zSYY4ZeOv6jOxTZgjpdgRXVWDImyGG3ATz7zNEhEqZAogrENbSIR5KjIvrS7Aiw/8zati2IepgeEPUeBOP6eOs6/g3/z1W0Gb9oRMmTYLJ/mP8uKzVQx06P9CcwBR6IlKEO8VXXPhKokeYweVflToXCkqFHwtMHWb1lnSalsZgNoJridwiOLMGvuBCgeT+/qJqaJOjW2q6rF34+6rQYrNdYegvs2gr4WK/NJIOXucKm5yc8EKMqKgqJHfE11Gqc38P3Nzp3hBFQmS3b3a3NiBBzQ27T4l+EovqL39tCvp//HTLCK1Qc03L6yaRJex0FI9iNnB4WrJ6oa3LuWdrfbG+9wpj3/ybHekPvO2o0dMtyom/TyFd3jSb2oL3u0OeSL7U1tHDzYZuXO6MrCp6HK72ya6ZsBRPGUt8f30A1R9xVzuI/1dct9/S1F0RY/RW4mXwXvoK5ACc5lb9N6J51Vz8vIbnvzA5ACd0/Tswj+2rsXu6FVkiz9B4n4Yl1IEV7S30jhKSsqXh3364ZRHjXZrs0cJLb64/1Lole7MJM271r6iqijW4Hf3Pqseqqv4Nf4mh2w==
sidebar_class_name: "get api-method"
info_path: docs/api/parameters
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List parameters"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/parameter"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List parameters by NRN.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"offset","schema":{"type":"integer","minimum":0,"default":0},"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"The maximum number of results to return per page.","example":30},{"name":"nrn","in":"query","description":"The NRN which the parameter belongs to.","required":true,"schema":{"type":"string"},"example":"organization=1:account=2:namespace=3:application=4"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"properties":{"paging":{"type":"object","required":["offset","limit","total"],"properties":{"total":{"type":"integer","description":"The total number of results matching the query.","example":30},"offset":{"type":"integer","minimum":0,"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},"limit":{"type":"integer","maximum":200,"description":"The maximum number of results to return per page. The maximum allowed value is 200.","example":200}}},"results":{"type":"array","items":{"type":"object","required":["id","name","nrn","type","encoding","secret","read_only","values","version_id"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the parameter.","example":1234},"name":{"type":"string","description":"The name of the parameter.","example":"Pool Size"},"nrn":{"type":"string","description":"The NRN of the application which the parameter belongs to.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"example":"environment","description":"The type of the parameter.","type":"string","enum":["environment"," file"],"title":"parameter_type"},"encoding":{"example":"plaintext","description":"The encoding of the parameter value.","type":"string","enum":["plaintext"," base64"],"title":"parameter_encoding"},"variable":{"type":"string","description":"The name of the environment variable. Required when `type` is `environment`."},"destination_path":{"type":"string","description":"The full file path. Required when `type` is `file`."},"secret":{"type":"boolean","description":"Indicates whether the value is a secret. `true` if it is a secret, `false` otherwise.","enum":[true,false]},"read_only":{"type":"boolean","description":"Indicates whether the value is read-only. `true` if it is read-only, `false` otherwise.","enum":[true,false]},"version_id":{"type":"integer","description":"A system-wide unique ID for the parameter version.","example":12341234},"values":{"type":"array","items":{"description":"The parameter values for this application or scopes.","type":"object","required":["id","nrn","created_at"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the value.","example":1234},"nrn":{"type":"string","description":"The NRN of the application which the parameter belongs to.","example":"organization=1:account=2:namespace=3:application=4"},"created_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the parameter value was created.","format":"date-time","example":"2021-01-02T00:00:00Z"},"value":{"type":"string","nullable":true,"description":"The value of the parameter.<br><br>\n> **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.\n","example":"200"},"location":{"type":"string","description":"The file path. Applicable only for files; null otherwise. Also null for secrets.","example":null},"external":{"type":"object","nullable":true,"description":"Object containing the external ID and engine of the value. \n>  **Note:** Applicable only for parameters stored in your own (external) infrastructure.\n","required":["id","engine"],"properties":{"id":{"description":"The external ID of the value.","type":"string","example":"external_id_123"},"engine":{"description":"The engine of the value. \n\n> **Note:** At the moment, only `hcp_vault` is supported.\n","type":"string","example":"hcp_vault"}}},"dimensions":{"type":"object","description":"The dimensions of the value.","example":{"environment":"development","country":"US"}}},"title":"parameter_value"}}},"title":"parameterResponse"}}},"title":"ParameterList"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>