---
title: "/enterprise/getPBXDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}"
slug: "enterprisegetpbxdetailsbypbxuseridorsipaorpbxuseridorsipaor-1"
updated: 2025-06-17T20:37:14Z
published: 2025-06-17T20:37:19Z
canonical: "kb.connecttoteams.com/enterprisegetpbxdetailsbypbxuseridorsipaorpbxuseridorsipaor-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://kb.connecttoteams.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /enterprise/getPBXDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}

Post/enterprise/getPBXDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}

Operation to retrieve PBX details of an Enterprise User's PBX Location.

SecurityOAuthFlowPassword Token URL/oauth/token
		

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='bf3fd4e1-cf0c-4d5d-a414-b6f4dfca11a3'>*/*</option>
</select>Array of object   object  _linksobject (Links)  property*object (Link)  additionalPropertiesdeprecationstring    
hrefstring    
hreflangstring    
namestring    
profilestring    
templatedboolean    
titlestring    
typestring    

acceptsEncodedFeatureCodeboolean    
apiAccessEnabledboolean    
apiIntegrationEnabledboolean    
callPolicyobject (PBXCallPolicyInfo)  callPolicyCNAMstring    Valid values[
  "TRANSPARENT",
  "OTHER"
]Default"TRANSPARENT"
callPolicyCustomCNAMstring    
callPolicyNamestring    Default"Global"
forwardedCallsCallerIdstring    Valid values[
  "USER_CALLER_ID",
  "TRANSPARENT"
]Default"USER_CALLER_ID"
resellerIdinteger  (int64)    

canonicalPbxSIPDomainstring    
codecsstring    
convertHistoryInfoToDiversionboolean    
credentialTemplateIdinteger  (int64)    
dnsLookupTypestring    
domainAlias Array of string   string    
enableMWIEventsboolean    
enforceCodecsOnInboundboolean    
escapeRequestUriboolean    
idinteger  (int64)    
metaSwitchSubscriptionCompatibilityboolean    
oldStyleHoldboolean    
parentCredentialTemplateInfoobject (PbxCredentialTemplateInfo)  apiCredentialDetailobject (PbxCredentialDetail)  accessCredentialOverrideboolean    
accessPasswordstring    
accessUsernamestring    
clientCredentialOverrideboolean    
clientIdstring    
clientSecretstring    
credentialTypestring    Valid values[
  "API",
  "SSO"
]
idinteger  (int64)    
ssoEndpointstring    
ssoEndpointOverrideboolean    
ssoProviderTypestring    
ssoUserPortalUrlstring    
ssoUserPortalUrlOverrideboolean    
tokenUrlstring    
tokenUrlOverrideboolean    

entPbxDetailsIdinteger  (int64)    
entityIdinteger  (int64)    
entityTypestring    
idinteger  (int64)    
masterResellerTemplateIdinteger  (int64)    
parentTemplateIdinteger  (int64)    
parentTemplateInfoobject (PbxCredentialTemplateInfo) Recursive  
pbxNamestring    
pbxTypeIdinteger  (int64)    
profileNamestring    
resellerTemplateIdinteger  (int64)    
ssoCredentialDetailobject (PbxCredentialDetail)  accessCredentialOverrideboolean    
accessPasswordstring    
accessUsernamestring    
clientCredentialOverrideboolean    
clientIdstring    
clientSecretstring    
credentialTypestring    Valid values[
  "API",
  "SSO"
]
idinteger  (int64)    
ssoEndpointstring    
ssoEndpointOverrideboolean    
ssoProviderTypestring    
ssoUserPortalUrlstring    
ssoUserPortalUrlOverrideboolean    
tokenUrlstring    
tokenUrlOverrideboolean    

pbxApiSettingsobject (PBXApiSettings)  initVectorstring    
locationIdinteger  (int64)    

PBX Location ID - cannot be empty.

managerPasswordstring    

API Access User Password - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

managerUsernamestring    

API Access Username - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxClientIdstring    

PBX Client ID - cannot be empty. This is the Client ID generated by the PBX vendor for this Enterprise to access the API

pbxClientSecretstring    

PBX Client Secret - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxTokenEndpointstring    

PBX token endpoint - cannot be empty. This is the Authorization URL that serves the Token for accessing the API using the client ID and Secret specified

wsdlLocationstring    

pbxHostingTypestring    
pbxIPAddressstring    
pbxLabelstring    
pbxLocationstring    
pbxSIPDomainstring    
pbxSIPDomainProxystring    
pbxSipAutoProvisionSettingsobject (PBXSipAutoProvSettings)  locationIdinteger  (int64)    

PBX Location ID - cannot be empty.

provisioningDIDFieldstring    
provisioningPasswordstring    

SIP Auto Provision Access User Password - cannot be empty.

provisioningServerAutoMacEnabledboolean    
provisioningServerCertificateConfigstring  (byte)    
provisioningServerCertificateNamestring    
provisioningServerEnabledboolean    
provisioningURLstring    
provisioningUsernamestring    

SIP Auto Provision Access Username - cannot be empty.

pbxSsoSettingsobject (PBXSsoSettings)  hasPortalboolean    
locationIdinteger  (int64)    
managerPasswordstring    

API Access User Password - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

managerUsernamestring    

API Access Username - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxClientIdstring    

PBX Client ID - cannot be empty. This is the Client ID generated by the PBX vendor for this Enterprise to access the API

pbxClientSecretstring    

PBX Client Secret - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxEUPortalstring    

PBX End User Portal - cannot be empty. This is the default URL that the Teams tab will fallback to when the SSO to the PBX fails

pbxSSOEndpointstring    

PBX SSO endpoint - cannot be empty. This is the URL that serves the End User Portal after the Credentials are authenticated.

pbxTokenEndpointstring    

PBX token endpoint - cannot be empty. This is the Authorization URL that serves the Token for accessing the API using the client ID and Secret specified

providerTypestring    
sameCredentialsAsPbxAPIboolean    

pbxTypestring    
presencePackageTypestring    
proxyDomainNamestring    
proxyDomainPortinteger  (int32)    
regExpiresValueinteger  (int64)    
rejectCallingboolean    
rejectIntervalinteger  (int64)    
rejectMethodstring    
sipWaitForAlegAckboolean    
tenantIdstring    
topologyHidingboolean    
transportTypestring    
voicemailFeatureCodestring
