---
title: "Read Tenants"
method: GET
path: "/tenants/"
tags: ["authenticated", "service-titan-tenant"]
---

# Read Tenants

`GET /tenants/`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/tenants/`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- ServiceTitanTenantPublic[]
  - `id` string, required
  - `name` string, required
  - `organization_id` string, required
  - `integration_id` string, required
  - `external_id` string, required
  - `properties` ServiceTitanSettings, required
    - `enterprise_hub_client_id` string, nullable
    - `last_precomputed_at` string, date-time, nullable: UTC timestamp of the last successful availability precompute run for this tenant
    - `zones_last_synced_at` string, date-time, nullable: UTC timestamp of the last successful zones ETL sync completion for this tenant
    - `adcap_business_unit_groups` ServiceTitanBusinessUnitGroupSnapshot[], nullable: Active ServiceTitan business-unit groups from the dispatch settings portal
      - `name` string, required
      - `business_unit_ids` integer[], required
    - `adcap_business_unit_groups_synced_at` string, date-time, nullable: UTC timestamp of the last successful business-unit-group portal sync
    - `adcap_business_unit_groups_unmapped_ids` integer[]: Business-unit ids in the portal snapshot that are absent from the local mirror
    - `adcap_business_unit_groups_sync_error` string, nullable: Error from the latest attempted business-unit-group portal sync
    - `declared_environment` string, nullable: The ServiceTitan environment the customer declared when connecting the tenant
    - `declared_environment_at` string, date-time, nullable: UTC timestamp of when the declared environment was last set to its current value
    - `app_install_requested_at` string, date-time, nullable: UTC timestamp of when the current tenant's app installation was requested
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)