---
title: "Get company variables"
method: GET
path: "/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/variables"
tags: ["Company"]
---

# Get company variables

`GET /api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/variables`

## Request

- Base URL: `https://api.currencyguard.com`
- URL: `https://api.currencyguard.com/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/variables`
- Auth: HTTP bearer

Returns the company's named variables. Any variable whose name ends in _PASSWORD, _SECRET, _TOKEN or _KEY is flagged secret=true. Its value IS returned here — this endpoint is the one place a credential is served, and clients obscure it until the user reveals it. No other endpoint returns it: the general DTOs have the variables object removed.

## Path parameters

- `introducingBrokerId` string, uuid, required
- `companyId` string, uuid, required

## Response `200`

Variables retrieved successfully

- EntityVariableDTO[]
  - `name` string: The variable name.
  - `value` string: The value. Returned for secret variables too — this endpoint is the one place a credential is served, and clients are expected to obscure it until the user reveals it.
  - `secret` boolean: Whether this variable is a credential and must be obscured on screen until revealed. True for any name ending in _PASSWORD, _SECRET, _TOKEN or _KEY.

## Other responses

- `401`: Not authenticated — [`security/authentication-failed`](/problems/security/authentication-failed/)
- `403`: Not authorized - requires REGULATED role or company not in your regulated entity — [`security/insufficient-permissions`](/problems/security/insufficient-permissions/)
- `404`: Company not found — [`http/resource-not-found`](/problems/http/resource-not-found/)
- `500`: Internal server error — [`server/internal-error`](/problems/server/internal-error/)

---

[API](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external.md) · [All operations](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/llms.txt) · [OpenAPI document](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/revisions/a1f3f854190d?raw)