v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-014589156.1 KB
Phones

List your phones

Returns private and rented phones owned by the caller's org. include_expired=true keeps rentals past their rental_expires_at in the result so users can see what they used to own.

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)

filter by phone status (ACTIVE/INACTIVE/MAINTENANCE/SUSPENDED)

typestring[] nullable

filter by phone type (IPHONE/ANDROID)

filter by phone type (IPHONE/ANDROID)

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

limitinteger required
offsetinteger required
totalinteger required