UPupsmith
authenticated
service-titan-tenant

Read Connection

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

get/tenants/connection

Request

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

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

installation_status'DISABLED' | 'INSTALLED' | 'NONE' | 'REQUESTED' required
credentials_refusedboolean required
tenant_idstring nullable required
environmentstring nullable required
app_update_availableboolean
reack_urlstring required
connection_type'tenant' | 'network'
network_group_statusstring nullable
network_tenant_statusstring nullable
network_idstring nullable
network_messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.