Tenant Variable

The Tenant Variable object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Tenant API keys must include tenant=CANISTRACCI; writes require a writable API key.

Object Summary

Property	Value
Object	`tenantvariable`
Primary path	`/tenantvariables`
ID field	`tv_id`
Label field	`tv_value`
Primary source table	`tv_tenantvariables`
Required on create	`tv_al_id`
Path aliases	`/variable`, `/variables`, `/tenantvariable`, `/tenantvariables`, `/tenant_variable`, `/tenant_variables`

Endpoint Patterns

Action	Example pattern
List	`GET https://pbx.example.com/pbx/openapi.php/tenantvariables?tenant=CANISTRACCI`
Get by ID	`GET https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI`
Create	`POST https://pbx.example.com/pbx/openapi.php/tenantvariables?tenant=CANISTRACCI`
Update	`PATCH https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI`
Delete	`DELETE https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI`

Accepted Field Aliases

Request field	Source field
`variable_id`	`tv_al_id`
`value`	`tv_value`
`comment`	`tv_comment`
`locked`	`tv_locked`

Examples

List Tenant Variables

Returns the tenant variables visible to the key and scope.

curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/tenantvariables?tenant=CANISTRACCI"

Get Tenant Variable

Reads one object by its internal ID.

curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI"

Create Tenant Variable

Creates a new object. Use the short aliases shown above or the source field names.

curl -X POST \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variable_id": 1,
  "value": "docs-value",
  "comment": "Docs API variable value"
}' \
  "https://pbx.example.com/pbx/openapi.php/tenantvariables?tenant=CANISTRACCI"

Edit Tenant Variable

Updates only the supplied fields.

curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "docs-updated-value"
}' \
  "https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI"

Delete Tenant Variable

Deletes the object. Check references before deleting configuration used by routing or reporting.

curl -X DELETE \
  -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/tenantvariables/OBJECT_ID?tenant=CANISTRACCI"

Common Errors

Error	Meaning
`missing_api_key`	No API key was supplied in the query string, `X-API-Key`, or bearer token.
`invalid_api_key`	The supplied key does not match the tenant or global API key.
`tenant_required`	A tenant code is required for tenant-scoped writes or tenant-key reads.
`read_only_api_key`	The key can read data but cannot create, update, or delete objects.
`missing_required_field`	A required create field is missing.