phone

List phones

get/v1/phones

Request

  • Base URL: https://phonebox.dev
  • URL: https://phonebox.dev/v1/phones
  • Auth: HTTP bearer

Query parameters

status'creating' | 'starting' | 'ready' | 'parking' | 'parked' | 'unavailable' | 'failed' | 'deleted'

Only the phones in this status. Without it, every phone but deleted and failed ones: ask for failed to list those.

limitinteger
cursorstring
metadataobject

Only phones with this metadata value: one key at a time, as metadata[customer]=acme.

Response

A page of phones, newest first.

next_cursorstring nullable required

Pass as cursor for the next page; null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.