Skip to main content
GET
/
crm
/
v3
/
extensions
/
calling
/
{appId}
/
settings
Retrieve settings
curl --request GET \
  --url https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings
{
  "createdAt": "2023-11-07T05:31:56Z",
  "supportsCustomObjects": true,
  "usesRemote": true,
  "isReady": true,
  "name": "<string>",
  "width": 123,
  "usesCallingWindow": true,
  "supportsInboundCalling": true,
  "url": "<string>",
  "height": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubStarter
Service HubService HubStarter
Content HubContent HubFree

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

The ID of the app.

Response

successful operation

​
createdAt
string<date-time>
required

When this calling extension was created.

​
supportsCustomObjects
boolean
required

When true, users will be able to click to dial from custom objects.

​
usesRemote
boolean
required

When false, this indicates that your calling app does not use the anchored calling remote within the HubSpot app.

​
isReady
boolean
required

When true, this indicates that your calling app is ready for production. Users will be able to select your calling app as their provider and can then click to dial within HubSpot.

​
name
string
required

The name of your calling service to display to users.

​
width
integer
required

The target width of the iframe that will contain your phone/calling UI.

​
usesCallingWindow
boolean
required

When false, this indicates that your calling app does not require the use of the separate calling window to hold the call connection.

​
supportsInboundCalling
boolean
required

When true, this indicates that your calling app supports inbound calling within HubSpot.

​
url
string
required

The URL to your phone/calling UI, built with the Calling SDK.

​
height
integer
required

The target height of the iframe that will contain your phone/calling UI.

​
updatedAt
string<date-time>
required

The last time the settings for this calling extension were modified.