Get tenant

Returns one org's public face — brand, company, operations, features and terminology.

GET /v1/patrol/tenant/{org}

Patrol → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/patrol/tenant/{org}`
Method	`GET`
Operation	`get_patrol_tenant_by_org`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one org's public face — brand, company, operations, features and terminology. It is the one anonymous route here: the front end loads it before anyone signs in. It carries no contact list and nothing operational, and an org with no tenant document is 404.

The org is a name a stranger supplied, so the read asks whether the deployment already holds that tenant before it opens anything. Resolving a store CREATES one, and a caller naming a fresh org on every request would leave a database per name they invented.

Request

1 field.

Field	In	Type	Required	Description
`org`	path	string	yes	Org is the IAM org the tenant belongs to, from the path.

Response

Status	Body	Meaning
`200`	patrol.patrolTenantOut	ok
`default`	problem-details	refused

200 body — 6 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolTenant	—
`data.brand`	body	any	—	Brand is the look: names, colours, logo references.
`data.company`	body	any	—	Company is the legal entity behind the operation — name, address, licence.
`data.features`	body	any	—	Features says which parts of the product this tenant runs.
`data.operations`	body	any	—	Operations is how the operation runs: coverage, timezone, SLA targets.
`data.terminology`	body	any	—	Terminology is the words this tenant's screens use for site, unit and officer.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo patrol tenant get <org>

.ts

.py

.go

.rs

.java

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolTenantByOrg({ org: 'org' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_tenant_by_org(org='org')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.GetPatrolTenantByOrg(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, patrol_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patrol_api::get_patrol_tenant_by_org(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatrolApi(client).getPatrolTenantByOrg();

curl https://api.hanzo.ai/v1/patrol/tenant/<org> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches patrol through the patrol tool, which names its 26 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_patrol_camera"
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList snapshot NextList tour