HighLevel: List active numbers

← Phone system operations · Get started

Operation gohighlevel.active_numbers

Provider route: GET /phone-system/numbers/location/{locationId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["phoneSystem"]["activeNumbers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.phoneSystem.activeNumbers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.phone_system.active_numbers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.pageSize	number	Optional	Maximum: 1000 Minimum: 1
query.page	number	Optional	Minimum: 0
query.searchFilter	string	Optional
query.skipNumberPool	boolean	Optional	Default: true
query.includeRcsSenderIds	boolean	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List active numbers — response body

Referenced models: List active numbers — response body

Schemas

List active numbers — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	V3 list payload: numbers, pagination fields, isUnderLc (renamed from isUnderGhl), etc.
data (allOf 1)	Model	All variants apply	Expand List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total
message	string	Required within parent	Human-readable success message.
status	string	Required within parent	Outcome indicator from the shared success helper. Known values: success
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	HTTP status echoed in the response body.
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total

List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total

Field	Type	Presence	Description and constraints
$	object	Root
accountStatus	string	Optional	Twilio account status for the location
isUnderLc	boolean	Optional	Whether the account is managed under LC. Renamed from isUnderGhl.
numbers	array	Required within parent	Active numbers available for the location
numbers[]	Model	Each item	Expand List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item
page	JSON	Optional
page (anyOf 1)	number	Alternative	The zero-based page index requested
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	number	Alternative	The page size requested
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rcsSenderIds	array	Optional	Optional RCS sender IDs returned with the number list
rcsSenderIds[]	Model	Each item	Expand List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total rcs Sender Ids item
total	JSON	Optional
total (anyOf 1)	number	Alternative	Total number of active numbers when available
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item, List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total rcs Sender Ids item

List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item

Field	Type	Presence	Description and constraints
$	object	Root
addressSid	string	Optional	Address SID used for regulated number purchases
bundleSid	string	Optional	Bundle SID used for regulated number purchases
capabilities	JSON	Optional	Phone number capabilities
capabilities (allOf 1)	Model	All variants apply	Expand List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item capabilities fax, mms, sms, voice
countryCode	string	Optional	ISO country code for the number
dateAdded	object	Optional	Date the number was added
dateCreated	object	Optional	Legacy created-at field returned by some providers
dateUpdated	object	Optional	Date the number was last updated
forwardingNumber	string	Optional	Forwarding number in E.164 format
friendlyName	string	Optional	Human-friendly label for the number
inboundCallService	object	Optional	Inbound call service metadata Additional keys: allowed
isDefaultNumber	boolean	Optional	Whether this is the default outbound number
isGroupConversationEnabled	boolean	Optional	Whether group conversations are enabled
linkedRingAllUsers	array	Optional	Ring-all user IDs linked to the number
linkedRingAllUsers[]	string	Each item
linkedUser	JSON	Optional
linkedUser (anyOf 1)	string	Alternative	Linked user ID if the number is assigned
linkedUser (anyOf 2)	null	Alternative
origin	string	Optional	Provider origin for the number
phoneNumber	string	Required within parent	Phone number in E.164 format
sid	string	Optional	Provider number identifier
type	string	Optional	Phone number type

Referenced models: List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item capabilities fax, mms, sms, voice

List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total rcs Sender Ids item

Field	Type	Presence	Description and constraints
$	object	Root
friendlyName	string	Optional	Human-friendly label for the sender ID
number	string	Required within parent	RCS sender ID
numberType	string	Required within parent	Entry type
rcsMeta	object	Optional	RCS sender metadata Additional keys: allowed

List active numbers — response body — data account Status, is Under Lc, numbers, page, page Size, rcs Sender Ids, total numbers item capabilities fax, mms, sms, voice

Field	Type	Presence	Description and constraints
$	object	Root
fax	boolean	Optional	Whether the number supports fax
mms	boolean	Optional	Whether the number supports MMS
sms	boolean	Optional	Whether the number supports SMS
voice	boolean	Optional	Whether the number supports voice calls

Policy, approvals and errors

SDK function policy ID: gohighlevel.active_numbers. Catalog operation: active-numbers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["phonenumbers.read"]

Pinned headers: {"Version": "v3"}

Official provider source