HighLevel: Phone system schemas

← Phone system operations · All 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 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

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

Purchase number for location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
addressSid	string	Required within parent	addressSid twilio address id
bundleSid	string	Required within parent	bundleSid twilio bundle id
countryCode	string	Required within parent	country for which the phone numbers are being requested
fingerprintId	string	Required within parent	fingerprintId is request id which is unique for every purchase number request
locality	string	Required within parent	locality of the user in which number is being purchased
numberType	object	Required within parent	type of phone number to be purchased
paymentIntentId	string	Required within parent	stripe payment intent id
paymentMethodId	string	Required within parent	stripe registered payment method id
phoneNumber	string	Required within parent	phoneNumber to purchase
region	string	Required within parent	region of the user in which number is being purchased
skipLocationKYC	boolean	Required within parent	Skip location-level KYC verification if agency-level compliance has already been verified
stripeAccountId	string	Required within parent	stripe account id

Purchase number for location — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	V3 purchase payload: purchased number, location, Twilio account id, and underLcAccount.
data (allOf 1)	Model	All variants apply	Expand Purchase number for location — response body — data id, location Id, number, under Lc Account
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: Purchase number for location — response body — data id, location Id, number, under Lc Account

Purchase number for location — response body — data id, location Id, number, under Lc Account

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Twilio account document identifier
locationId	string	Required within parent	Location that owns the Twilio / numbers account
number	string	Required within parent	E.164 phone number that was purchased (from the request body)
underLcAccount	boolean	Required within parent	Whether the account is managed under LC. Renamed from under_ghl_account in the legacy document.