Phones

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.

GET

phones

curl --request GET \
  --url https://api.axilio.ai/api/v1/phones \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/phones', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/phones",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/phones"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/phones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "limit": 123,
  "offset": 123,
  "phones": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "current_session_id": "<string>",
      "last_heartbeat": "2023-11-07T05:31:56Z",
      "last_interaction_timestamp": "2023-11-07T05:31:56Z",
      "location": "<string>",
      "model_id": "<string>",
      "model_name": "<string>",
      "nickname": "<string>",
      "owner_organization_id": "<string>",
      "ownership_type": "shared",
      "phone_id": "<string>",
      "phone_name": "<string>",
      "phone_type": "android",
      "rental_expires_at": "2023-11-07T05:31:56Z",
      "status": "active",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

ownership

enum<string>

required

Which phones to return. 'dedicated' = the org's dedicated/rented inventory in every state (busy, offline, and maintenance phones included).

Available options:

dedicated

include_expired

boolean

include rented devices whose rental window has expired

limit

integer<int64>

default:100

Required range: 1 <= x <= 500

offset

integer<int64>

default:0

Required range: x >= 0

string

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

status

string[] | null

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

type

string[] | null

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

rental_expires_after

string

only phones whose rental expires at/after this RFC3339 time

rental_expires_before

string

only phones whose rental expires at/before this RFC3339 time

last_active_after

string

only phones last seen at/after this RFC3339 time

last_active_before

string

only phones last seen at/before this RFC3339 time

sort

string

order

string

sort direction (asc|desc)

Response

Privately owned devices for an organization.

limit

integer<int64>

required

Page size used for this response.

offset

integer<int64>

required

Pagination offset used for this response.

phones

object[] | null

required

Page of private device records.

Show child attributes

total

integer<int64>

required

Total number of private devices matching the query.

List the org's phones

curl --request GET \
  --url https://api.axilio.ai/api/v1/phones \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/phones', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/phones",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/phones"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/phones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "limit": 123,
  "offset": 123,
  "phones": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "current_session_id": "<string>",
      "last_heartbeat": "2023-11-07T05:31:56Z",
      "last_interaction_timestamp": "2023-11-07T05:31:56Z",
      "location": "<string>",
      "model_id": "<string>",
      "model_name": "<string>",
      "nickname": "<string>",
      "owner_organization_id": "<string>",
      "ownership_type": "shared",
      "phone_id": "<string>",
      "phone_name": "<string>",
      "phone_type": "android",
      "rental_expires_at": "2023-11-07T05:31:56Z",
      "status": "active",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Vision API

List the org's phones

Authorizations

Query Parameters

Response