Skip to content

Context Variables

Company configuration variables, set per company, project, workflow or agent and resolved by precedence.

Get configuration variables for a scope

Request

Get configuration variables for a specific scope. If no scopeType/scopeId is provided, returns company-level variables.

Security
OAuth2(Required scopes: context-vars.read)
Query
scopeTypestring(ScopeType)
Enum:"PROJECT""PS_WORKFLOW""PS_AGENT""CE_WORKFLOW"
scopeIdstring
Headers
X-Hy-Meta-Internal-Company-Idstring

Company ID for service account authorization

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/context-vars/configurations?scopeType=PROJECT&scopeId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Hy-Meta-Internal-Company-Id: string'

Responses

Configuration variables for the scope. Returns empty variables list if no configuration exists.

Bodyapplication/json
scopeTypestring(ScopeType)
Enum:"PROJECT""PS_WORKFLOW""PS_AGENT""CE_WORKFLOW"
scopeIdstring
variablesArray of objects(Variable)required
Response
{ "scopeType": "PROJECT", "scopeId": "string", "variables": [ { … } ] }