Skip to main content
GET
List Phones

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

after
string<uuid> | null
before
string<uuid> | null
page
integer | null
Rango requerido: x >= 1
limit
integer
predeterminado:20
Rango requerido: 1 <= x <= 100
order
enum<string>
predeterminado:desc
Opciones disponibles:
asc,
desc
inbound_agent_id
string<uuid> | null
outbound_agent_id
string<uuid> | null
status
enum<string> | null

Enum representing the status of a phone number register. The cycle is as follows:

  • RESERVED: The phone number is held while a purchase is in checkout (no payment intent yet); locked so two companies can't buy the same number at once.
  • PENDING_VERIFICATION: The purchase is paid (manual-capture hold authorized) but awaiting verification approval for an unverified company; the number is theirs pending admin review.
  • ASSIGNED: The phone number is assigned to a company
  • RELEASED: The phone number is released from the company and is pending availability for purchase (30 days before it can be purchased again)
  • FINISHED: The phone register process is finished, and the phone number is available for purchase again. Once a phone number reaches this status, it cannot return to previous statuses.
Opciones disponibles:
reserved,
pending_verification,
assigned,
released,
finished
start_assigned_at
string<date-time> | null
end_assigned_at
string<date-time> | null

Respuesta

Successful Response

data
PhoneRegisterResponseSchema · object[]
requerido
has_more
boolean
requerido
first_id
string<uuid> | null
last_id
string<uuid> | null
current_page
integer | null
total_pages
integer | null