Sign in

v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB
phones

List the org's dedicated 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.

get/phones/my

Query parameters

include_expiredboolean

include rented devices whose rental window has expired

include rented devices whose rental window has expired

limitinteger
offsetinteger
searchstring

free-text search across nickname, name, model, location

free-text search across nickname, name, model, location

statusstring[] nullable

filter by phone status (active/inactive/maintenance/suspended); case-insensitive

filter by phone status (active/inactive/maintenance/suspended); case-insensitive

typestring[] nullable

filter by phone type (iphone/android); case-insensitive

filter by phone type (iphone/android); case-insensitive

rental_expires_afterstring

only phones whose rental expires at/after this RFC3339 time

only phones whose rental expires at/after this RFC3339 time

rental_expires_beforestring

only phones whose rental expires at/before this RFC3339 time

only phones whose rental expires at/before this RFC3339 time

last_active_afterstring

only phones last seen at/after this RFC3339 time

only phones last seen at/after this RFC3339 time

last_active_beforestring

only phones last seen at/before this RFC3339 time

only phones last seen at/before this RFC3339 time

sortstring

sort column (created|rental_expires|last_active|status|type|location)

sort column (created|rental_expires|last_active|status|type|location)

orderstring

sort direction (asc|desc)

sort direction (asc|desc)

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of private devices matching the query.

Example response

{
  "$schema": "/api/v1/PhonePrivateListResponse.json",
  "phones": [
    {
      "$schema": "/api/v1/PhoneSummary.json"
    }
  ]
}