phones
Phone availability summary
Returns a capacity snapshot to check before POST /phones:allocate: shared-pool availability broken down by phone type and by location, plus the caller org's dedicated phones with how many are idle (claimable right now). Optional phone_type and location filters narrow every count. Advisory only - availability can change between this read and an allocate, so allocation remains the authority and can still refuse.
get/phones/availability
Query parameters
phone_type'android' | 'iphone'
Only count phones of this platform.
Only count phones of this platform.
locationstring
Only count phones at this location slug.
Only count phones at this location slug.
Response
OK
Example response
{
"$schema": "/api/v1/PhoneAvailabilityResponse.json"
}