Who would arrive if this unit's Autonomy Zone were enabled

GET/api/public/v1/org-units/{unit_id}/zone/preview

Agents with no manual assignment whose placement sits at or under the unit and whose current zone is above it — the agents for which the new zone would become the deepest — each with the placement link that brings it (owner · accountable_person · accountable_unit) and whether that link was set by hand. auto_arrivals is the total; agents lists the first 500 by display name. 409 ZONE_EXISTS when the unit already carries a zone.

cURL

curl --fail-with-body -X GET 'https://app.openlatch.ai/api/public/v1/org-units/<unit_id>/zone/preview' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY"

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/org-units/<unit_id>/zone/preview',
    method='GET',
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X GET 'https://app.openlatch.ai/api/public/v1/org-units/<unit_id>/zone/preview' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
Invoke-RestMethod -Method GET -Uri 'https://app.openlatch.ai/api/public/v1/org-units/<unit_id>/zone/preview' -Headers $headers | ConvertTo-Json -Depth 20

Autorisation

Rôle dans l’organisation	Ce point de terminaison
owner	Autorisé
admin	Autorisé
editor	Non autorisé
viewer	Non autorisé

Une clé porte le rôle que son propriétaire détient dans l’organisation. Voir Authentification.

Portée de clé d’API : zones:read

Paramètres de chemin

Paramètre	Type	Description
unit_id	string (uuid)	Obligatoire.

Réponse

• 200 OK — l’appel a réussi.
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND
• 409 Conflict — ZONE_EXISTS
• 422 Unprocessable Content — INVALID_ID, VALIDATION_ERROR
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Champs de la réponse

Champ	Type	Description
agents	array of object	Obligatoire.
agents[].agent_id	string	Obligatoire.
agents[].current_zone	object	Obligatoire.
agents[].current_zone.id	string	Obligatoire.
agents[].current_zone.label	string	Obligatoire.
agents[].reason	object	Obligatoire.
agents[].reason.kind	string — one of owner, accountable_person, accountable_unit	Obligatoire.
agents[].reason.person	object or null
agents[].reason.source	string — one of directory, manual	Obligatoire.
agents[].reason.unit	string	Obligatoire.
auto_arrivals	integer	Obligatoire.

Exemple de réponse

{
  "agents": [
    {
      "agent_id": "agt_01jbwa2k1vfrn9y42xhgxhmzj2",
      "current_zone": {
        "id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10",
        "label": "string"
      },
      "reason": {
        "kind": "owner",
        "person": "string",
        "source": "directory",
        "unit": "string"
      }
    }
  ],
  "auto_arrivals": 3
}

Voir aussi

• DELETE Rétablir l’affectation automatique de zone d’un agent
• GET Ce qui s’applique à cet agent
• PUT Affecter un agent à une zone à la main