List the org's phones
Returns the caller org's full dedicated (private/rented) phone inventory - every state, not just the free ones: busy phones in an active session, offline/inactive phones, and phones in maintenance are all included, so this is the endpoint to discover a phone_id you can pin via POST /phones:allocate. Each phone's current_session_id and status reflect its live state. include_expired=true also keeps rentals past their rental_expires_at so users can see what they used to own. Filter by status/phone_type and paginate; the response total is the full match count. Pass ownership=dedicated.
Query parameters
Which phones to return. 'dedicated' = the org's dedicated/rented inventory in every state (busy, offline, and maintenance phones included).
Which phones to return. 'dedicated' = the org's dedicated/rented inventory in every state (busy, offline, and maintenance phones included).
include rented devices whose rental window has expired
include rented devices whose rental window has expired
free-text search across nickname, name, model, location
free-text search across nickname, name, model, location
filter by phone status (active/inactive/maintenance/suspended); case-insensitive
filter by phone status (active/inactive/maintenance/suspended); case-insensitive
filter by phone type (iphone/android); case-insensitive
filter by phone type (iphone/android); case-insensitive
only phones whose rental expires at/after this RFC3339 time
only phones whose rental expires at/after this RFC3339 time
only phones whose rental expires at/before this RFC3339 time
only phones whose rental expires at/before this RFC3339 time
only phones last seen at/after this RFC3339 time
only phones last seen at/after this RFC3339 time
only phones last seen at/before this RFC3339 time
only phones last seen at/before this RFC3339 time
sort column (created|rental_expires|last_active|status|type|location)
sort column (created|rental_expires|last_active|status|type|location)
sort direction (asc|desc)
sort direction (asc|desc)
Response
OK