Skip to main content
GET
Get organization phone number details by ID

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

phoneNumberId
string
required

The phone number identifier.

Response

Returns the phone number response.

Describes a Leadping-managed phone number, including capabilities, messaging registration, health, and assignment details.

smsReady
boolean

Whether provider, routing, and health checks allow SMS.

voiceReady
boolean

Whether provider, routing, and health checks allow calls.

numberHealthEnabled
boolean

Opts this number into the optional $2 monthly number health add-on. Defaults to on; customers can opt out.

number
string

E.164 phone number exposed by this phone number.

phoneIdentityId
null | string

Identifier of the canonical phone identity for this number.

organization
object | null

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

leadpingOwned
boolean

Indicates whether Leadping provisions and manages this phone number.

routing
object

Public Leadping API schema for phone number routing metadata data.

enabled
boolean

Indicates whether this phone number is active and available in the Leadping API.

warmup
object

Messaging and calling warmup for a Leadping phone number.

name
string

Human-readable display name of the resource.

id
string

Stable unique identifier of the resource.

createdAt
string<date-time>

UTC timestamp when the resource was created.

modifiedAt
null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.