---
id: workflow-config-read
title: "Read a secret or variable"
description: "Returns one entry by id. `value` is only present for non-secret entries."
sidebar_label: "Read a secret or variable"
hide_title: true
hide_table_of_contents: true
api: eJytWG1v4zYS/isD4oBmXVlOiy3aCrgP3r3sIS26DbK7SA/bIKLFkcVGIlVyZMdn+L8fhpT8EjuboL18iSIN5/WZmYdZC5JzL7LP4sa6+7K2S/BYOCQP0ihYSKflrEYvbhOh0BdOt6StEZm4Ruqc8WANAhpyK5itQKsU8oWsO8xB87d6Ba1Dj4agtA6MNeOoP5zR6FORCNuik6z2UolMLHtHxoU1pZ5nDqUSiWilkw0SOvZ2LTT70EqqRCKMbFBkQrOYwz877VCJjFyHifBFhY0U2VrQqmUpT06budg8judjhRAt9uFoBWd5Uc7v0jTNX7Gf+CCbtmYl/Prb2Y/qm/Jcis1tIjwWndO0Cr7NUDp0044qkX2+5c8OfWuNR8+OfHt+zr+OzQe7bKiwhtAQS8m2rXURsjP5w7Poej8mTcGft8HxCz4vkiFSO/sDCxKPA532FQbrtvVN4eJBFlSvQjltCTmnNmeRfKhHDlqhIV1q9EAVQlvLAkET1HqBPoUPUW0ovwfpEJZOE44ZBRmfWIWXBhfowAX4oGLUSLMCrnJ6UL/PsaChuCHBDjmYwqEkVFN+7lrVP98monWMI9IxyVod1/zpCg4YOj7xGPQlOjQFKtAGFJbaaP7kQXrI/7FeD92Tvp/+cgGbTUwhf1hIt3t7iKb3V3fTq8u7ny/+w570ke58mVlbozRHzlw2TUexejmDPYdG3ve1CUXYy3/oZodKFoQKuAKrZYUOU7YY2ujZ2N/ZWqHrq36WT0KHsy3r5tLo/waMgrOWXqVw1Tf9skIThGJPBaSANSChDOoOEzGRBSsZa8LGs2cD9p73bju+3FCi551grA8WQiJC1k7ZMl1dc6aHqXJo+1dO8BbQT825TSKwLLEgvcAXVDcoXWqqIJemQE/W+X+GMmccEFXogCrtwdklLLXxPGgLVBx68EGTB0Z1sNxYdTIwNF3DrdZ31a6njgf+DYMJtpMMYlvvXBnSu5QeenXQuxHR6Czxy+BPL/BmdXIy73r8hMuldY0kkQn2c0y6QT6yGwUvPBJ+EvH6t9+Oh/HbWjNu0DnrEm7ttpbawE8ffn3/d8Yzq3t2PIdFwJIws2o1zJOxNGq83caARrVWG/I97DKQ0Mii0gbHPElZCgqreEh3nj+i93KO7P3hnAymnm+vX04pTwDTeQq5NgtZa3XHaMuT3d9hVPCLGMRdWcv5nR6mFn8wlu5K2xn1aCIeaAj4jf5/eaZfObvQCgEPdxmPN0bidpgMtf/uVO0/GXxoMYxJj45XVUjRF+reOjursfn66fpfRYkX1d6TNEo6tQ+Cs+t3b+H7H86/h94WKCSpa59EH1VYP0/5FMnLYdmjH89VPSAWWAY+XV8O5a6IWp9NJlui5leesEkVLibBab/7ZCyNTxX4L+lgIPQp/RIM3lsmm728J0ndXshCG8I5uv0Tr89fBzrIKX1O9RZFcTZrBcvyTpc3b2Y3ZdvNzw3gg/YUtpc2XMziGXe3gfrJHqGYPFIb1kdIzJ426ZxcHVVtWHvWQOiiuJhLqevOoc/2GHuLDmxZolHazKHUWAcOFtfvzswWrYcYeoo27IXmCVs/8YU0k8itX9zLTecJKrngjRMZIfTWV/AVD5+v+jaOrdwgVZZvD/NAEqNr+6mN5idrrTaBTXJnx5tE5+o9QMpWp7zt21oSr420sM0Bw//A3R0TsM/zt7GwItHfO8J+D0Ii6R/eDavop5uPYhNAUtr9WTEQGS8SwT7Gmp6n36TnR5V+0+laJdB2s1r7KgHXmSQwPTsLEW7BGugOr+j90HZQRjPXBtPfze/mne0cE33pB16HkWZMry4zFhjDaPSvHU5Ho0DqWfdWnbJF16Ahn8IFM03wXMcZFrbhiwGYrpkhV3Q0crjQHOJolIC3YCxVDEXtA0eF2npKo81praXHwR6vGgVhB6LzQBYkDLrgrNb3CDnzvPxVClOmXJJYrzQgWQ8bWFaSIN5hmaOQ0/M567Kmt3jxgEU3BOmwsK5nzjHPjG2+vfDvpJ8Gpu3IJ2A7ig9ci9rOfa/xw6mr9WgE94gtc6Zwv5J1FPBI7LNnbbzGOMW7ARGJu/XUyLB0+jvwNUoF8sQN7zF21rtt9v+8yvdNQPhAk0CaAjdz9W5efN6Seh9XKk+FRGQ6UM7KemKZ9XomPX5y9WbDr//s0PHd+pY5eh8Q967Snp+VyEpZ+8fEfD/Gs+t+jLyCF9z0T4YxDF3DI7e/KgiRiHtcxf8+bG43iahQKnTBu/hhWhTY0t6RI87I42U7wP598VEkQh4OlUdDJGg/6c56HSU+2ns0m83WO+K/2cHN5n9mAEYM
sidebar_class_name: "get api-method"
info_path: docs/api/workflows
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={"Read a secret or variable"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/workflows/config/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Returns one entry by id. `value` is only present for non-secret entries.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The config entry id (`cfg_...`).","example":"cfg_2b9d1f0a"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The entry.","content":{"application/json":{"schema":{"title":"ConfigEntry","type":"object","description":"A secret or variable. Exactly one of `path` or `workflow` identifies the place it lives. Secret values are write-only: they are never returned by any read.","required":["id","name","secret","createdAt","updatedAt"],"properties":{"id":{"type":"string","example":"cfg_2b9d1f0a"},"name":{"type":"string","description":"Referenced in definitions as `${{ secrets.NAME }}` or `${{ vars.NAME }}`.","example":"NP_API_KEY"},"secret":{"type":"boolean","description":"Immutable. `true` makes the value write-only and redacted everywhere."},"path":{"type":"string","description":"Folder place (`/` is the organization root). Present when the entry lives on a folder.","example":"/action-items"},"workflow":{"type":"string","description":"Workflow reference. Present when the entry lives on one workflow."},"value":{"type":"string","nullable":true,"description":"Only returned for non-secret entries."},"effective":{"type":"boolean","description":"Only with `ancestors=true`: whether this row wins precedence for its name."},"mode":{"type":"string","enum":["created","updated"],"description":"Write responses only: whether the entry was created or its value rotated."},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}},"4XX":{"description":"Client error, as plain JSON.","content":{"application/json":{"schema":{"title":"ConfigError","type":"object","description":"The error body secrets-and-variables endpoints return: a machine-readable code plus a message.","properties":{"error":{"type":"string","description":"Machine-readable code, e.g. `invalid_name`, `invalid_place`, `secret_flag_immutable`, `not_found`.","example":"invalid_place"},"message":{"type":"string","example":"Provide exactly one of path or workflow"}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>
  
</StatusCodes>