List active phone numbers registered for the account.

GET

/numbers/list

curl --request GET \
  --url https://api.pingram.io/numbers/list \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Responses

200

Successful response

Media typeapplication/json

object

numbers

required

Array<object>

Represents a phone number in the account

object

phoneNumber

required

E.164

string

label

string

createdAt

required

ISO timestamp when the number was registered

string

countryCode

required

ISO 3166-1 alpha-2 country code

string

numberType

required

E.g. local, toll_free

string

billingStatus

required

Active or released

string

Allowed values: active released

nextBillingDate

required

YYYY-MM-DD next monthly rent charge

string

monthlyPrice

required

Monthly cost in USD

number

a2pStatus

US 10DLC readiness derived from stored campaign assignment

string

Allowed values: pending testing approved

releasedAt

ISO timestamp when the number was released (released numbers only)

string

sharedNumber

required

E.164 shared number the account can send from when it has no dedicated number.

string

Example

{
  "numbers": [
    {
      "billingStatus": "active",
      "a2pStatus": "pending"
    }
  ]
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}