v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Phones

List phones

List an account's phone numbers with filtering options.

get/accounts/v1/accounts/{accountId}/phones

Path parameters

accountIdinteger required

Example:6912345

Account ID

Query parameters

type'RESIDENTIAL' | 'MOBILE' | 'COMMERCIAL'

Example:RESIDENTIAL

Account phone type

activefalse | true

Example:true

Filter results based on whether the phone is active or not.

Response

Phone numbers list

idinteger

Phone ID

account_idinteger

Account ID

area_codestring

Phone number area code

numberstring

Phone number

type'RESIDENTIAL' | 'COMMERCIAL' | 'MOBILE'

Phone number type

extensionstring

Optional phone number extension

activeboolean

Is phone active? Default is true.

org_idstring

Organization ID

country_codestring

Phone number's country code

creation_datestring date-time

Phone date creation. RFC 3339 format.

last_updatestring date-time

Date of last phone update

customer_idinteger

Pismo customer ID.

Example response

[
  {
    "id": 8714,
    "account_id": 6912345,
    "area_code": "51",
    "number": "11912345678",
    "type": "MOBILE",
    "extension": "ext. 9",
    "org_id": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be",
    "country_code": "555",
    "creation_date": "2021-10-21T00:00:00Z",
    "last_update": "2021-10-21T00:00:00Z",
    "customer_id": 5648988
  }
]