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

get

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

Authorizations

Nected-API-KeystringRequired

Your Nected API key. Obtain from workspace settings.

Path parameters

namestringRequired

The variable name (as set on create)

Example: tax_rate_gst

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Responses

200

OK — full variable object

application/json

Standard response wrapper for single-variable operations (create, get-by-name, update)

codestringOptionalExample: success

messagestringOptionalExample: Success.

404

Not Found — no variable with that name

application/json

500

Internal Server Error

application/json

get/dev/variable/{name}

GET /dev/variable/{name} HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Accept: */*

{
  "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."
}

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.