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

# Read Connection

`GET /tenants/connection`

## 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/connection`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

The caller's own organization's ServiceTitan connection, for the Integrations page.

## 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

- ServiceTitanConnectionPublic
  - `installation_status` 'DISABLED' | 'INSTALLED' | 'NONE' | 'REQUESTED', required
  - `credentials_refused` boolean, required
  - `tenant_id` string, nullable, required
  - `environment` string, nullable, required
  - `app_update_available` boolean
  - `reack_url` string, required
  - `connection_type` 'tenant' | 'network'
  - `network_group_status` string, nullable
  - `network_tenant_status` string, nullable
  - `network_id` string, nullable
  - `network_message` string, 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)