Basic

Retrieve the calling extension settings for a specific app.

Changed on

Retrieve the current settings of the calling extension for the specified appId.

get/crm/extensions/calling/2026-09/{appId}/settings

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/extensions/calling/2026-09/{appId}/settings
  • Auth
    API key in query parameter hapikey

Path parameters

appIdinteger required

Response

successful operation

createdAtstring date-time required

The date and time when the calling extension settings were created.

heightinteger required

The height of the calling extension interface.

isReadyboolean required

Specifies whether the calling extension settings are ready for use.

namestring required

The name of the calling extension.

supportsCustomObjectsboolean required

Indicates if the calling extension supports custom objects.

supportsInboundCallingboolean required

Indicates if the calling extension supports inbound calling.

updatedAtstring date-time required

The date and time when the calling extension settings were last updated.

urlstring required

The URL associated with the calling extension.

usesCallingWindowboolean required

Specifies if the calling extension uses a dedicated calling window.

usesRemoteboolean required

Indicates if the calling extension uses a remote service.

widthinteger required

The width of the calling extension interface.

Changes

  • 2026-098bccef69948cRevision changes
    • info

      the endpoint scheme security developer_hapikey was added to the API

    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2026-0935046bde1057Revision changes
    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      the endpoint scheme security developer_hapikey was removed from the API