authenticated
service-titan-tenant

Read Tenant Properties

get/tenants/{tenant_id}/properties

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

Path parameters

tenant_idstring required

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

enterprise_hub_client_idstring nullable
last_precomputed_atstring date-time nullable

UTC timestamp of the last successful availability precompute run for this tenant

zones_last_synced_atstring date-time nullable

UTC timestamp of the last successful zones ETL sync completion for this tenant

adcap_business_unit_groups_synced_atstring date-time nullable

UTC timestamp of the last successful business-unit-group portal sync

adcap_business_unit_groups_unmapped_idsinteger[]

Business-unit ids in the portal snapshot that are absent from the local mirror

adcap_business_unit_groups_sync_errorstring nullable

Error from the latest attempted business-unit-group portal sync

declared_environmentstring nullable

The ServiceTitan environment the customer declared when connecting the tenant

declared_environment_atstring date-time nullable

UTC timestamp of when the declared environment was last set to its current value

app_install_requested_atstring date-time nullable

UTC timestamp of when the current tenant's app installation was requested

Changes

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