> For the complete documentation index, see [llms.txt](https://docs.nected.ai/nected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nected.ai/nected-docs/management-api/global-variable-api/get-global-variable-by-name.md).

# Get Global Variable by Name

Fetch a single global variable by its `name`. The response includes the full variable object including `checksum` — copy this before calling update or delete.

The `value` field is masked as `***` when `isSecret` is `true`.

## Get global variable by name

> Fetch a single global variable by its \`name\`.\
> \
> \*\*Response \`data\`\*\* includes the full variable object: \`name\`, \`dataType\`, \`value\` (masked for secrets), \`isSecret\`, \`canReset\`, \`checksum\`, \`createdAt\`, \`updatedAt\`.\
> \
> \*\*Copy \`data.checksum\`\*\* from this response before calling update or delete.\
> \
> \*\*Canonical response file:\*\* \`Get/GET\_BY\_NAME.json\`

```json
{"openapi":"3.0.3","info":{"title":"Nected Global Variable API","version":"1.0"},"tags":[{"name":"GlobalVariable","description":"Create, read, update, and delete global variables."}],"servers":[{"url":"https://api.nected.ai","description":"Production"}],"security":[{"DevAuth":[]}],"components":{"securitySchemes":{"DevAuth":{"type":"apiKey","in":"header","name":"Nected-API-Key","description":"Your Nected API key. Obtain from workspace settings."}},"schemas":{"VariableResponse":{"type":"object","description":"Standard response wrapper for single-variable operations (create, get-by-name, update)","properties":{"data":{"$ref":"#/components/schemas/GlobalVariable"},"code":{"type":"string"},"message":{"type":"string"}}},"GlobalVariable":{"type":"object","description":"A global variable object as returned by get and list endpoints","properties":{"name":{"type":"string","description":"Unique variable name within the workspace"},"dataType":{"type":"string","description":"Data type — one of `string`, `numeric`, `boolean`, `json`","enum":["string","numeric","boolean","json"]},"value":{"description":"Variable value. Masked as `***` in responses when `isSecret` is true."},"isSecret":{"type":"boolean","description":"When true, value is masked in all get/list responses"},"canReset":{"type":"boolean","description":"When true, the variable can be reset to its original value via the UI"},"checksum":{"type":"string","description":"Current checksum — required for update and delete operations"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"ErrorResponse":{"type":"object","description":"Error response wrapper","properties":{"code":{"type":"string"},"message":{"type":"string","description":"Human-readable error description"},"data":{"nullable":true}}}}},"paths":{"/dev/variable/{name}":{"get":{"operationId":"getGlobalVariableByName","tags":["GlobalVariable"],"summary":"Get global variable by name","description":"Fetch a single global variable by its `name`.\n\n**Response `data`** includes the full variable object: `name`, `dataType`, `value` (masked for secrets), `isSecret`, `canReset`, `checksum`, `createdAt`, `updatedAt`.\n\n**Copy `data.checksum`** from this response before calling update or delete.\n\n**Canonical response file:** `Get/GET_BY_NAME.json`","parameters":[{"name":"Nected-Branch","in":"header","required":false,"description":"Branch name (optional)","schema":{"type":"string"}},{"name":"name","in":"path","required":true,"description":"The variable name (as set on create)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK — full variable object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableResponse"}}}},"404":{"description":"Not Found — no variable with that name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

### Example response (full JSON)

```
{
  "data": {
    "name": "tax_rate_gst",
    "dataType": "numeric",
    "value": 18,
    "isSecret": false,
    "canReset": true,
    "checksum": "a3f1b2c4d5e6f7a8b9c0d1e2f3a4b5c6",
    "createdAt": "2026-01-10T10:00:00.000Z",
    "updatedAt": "2026-04-22T08:30:00.000Z"
  },
  "code": "success",
  "message": "Success."
}
```

Use the API reference below to try the endpoint.