Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Endpoint
/
List All Endpoints
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 4,
    "next": null,
    "previous": null
  },
  "objects": [
    {
      "alias": "Acme Desktop Phone",
      "application": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
      "endpoint_id": "147322537258167",
      "resource_uri": "/v1/Account/MA_XXXXXXXX/Endpoint/147322537258167/",
      "sip_registered": "false",
      "sip_uri": "sip:acme_sip_user_01@registrar.vobiz.ai",
      "sub_account": null,
      "username": "acme_sip_user_01"
    },
    {
      "alias": "SIP Demo Phone",
      "application": null,
      "endpoint_id": "125649946800674",
      "resource_uri": "/v1/Account/MA_XXXXXXXX/Endpoint/125649946800674/",
      "sip_registered": "false",
      "sip_uri": "sip:sipuser_demo@registrar.vobiz.ai",
      "sub_account": null,
      "username": "sipuser_demo"
    }
  ]
}
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/
Returns a paginated list of all endpoints configured in your account. The response includes complete details for each endpoint, including registration status and attached applications.
Authentication required:
  • X-Auth-ID - Your account Auth ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Query Parameters

FieldTypeRequiredDescription
limitintegerNoNumber of results per page (max 100, default: 20).
offsetintegerNoNumber of results to skip (default: 0).
username__containsstringNoFilter by username (partial match).
username__exactstringNoFilter by exact username.
username__startswithstringNoFilter by username prefix.
alias__containsstringNoFilter by alias (partial match).
alias__exactstringNoFilter by exact alias.
application_id__exactintegerNoFilter by application ID.
application_id__isnullbooleanNoFilter endpoints without application.
sub_accountstringNoFilter by sub-account auth_id.

​
Response

Returns a dictionary with an objects array of Endpoint objects and a meta object with pagination information.
Response - 200 OK
{
  "api_id": "550e8400-e29b-41d4-a716-446655440000",
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 45,
    "next": null,
    "previous": null
  },
  "objects": [
    {
      "endpoint_id": "87654321",
      "username": "john_doe",
      "alias": "John's Desktop Phone",
      "sip_uri": "sip:john_doe@sip.vobiz.ai",
      "sip_registered": "true",
      "sip_contact": "192.168.1.100:5060",
      "sip_expires": "2025-10-28T11:30:00Z",
      "sip_user_agent": "Zoiper v5.4.5",
      "application": {
        "app_id": "12345678",
        "app_name": "Customer Service App"
      },
      "allow_voice": true,
      "allow_message": true,
      "allow_video": false,
      "allow_same_domain": true,
      "allow_other_domains": false,
      "allow_phones": true,
      "allow_apps": true,
      "sub_account": null,
      "resource_uri": "/v1/Account/{auth_id}/Endpoint/87654321/",
      "created_at": "2025-10-27T10:30:00Z",
      "updated_at": "2025-10-28T09:15:00Z"
    },
    {
      "endpoint_id": "87654322",
      "username": "jane_smith",
      "alias": "Jane's Mobile",
      "sip_uri": "sip:jane_smith@sip.vobiz.ai",
      "sip_registered": "false",
      "sip_contact": null,
      "sip_expires": null,
      "sip_user_agent": null,
      "application": null,
      "allow_voice": true,
      "allow_message": true,
      "allow_video": true,
      "allow_same_domain": true,
      "allow_other_domains": false,
      "allow_phones": true,
      "allow_apps": true,
      "sub_account": null,
      "resource_uri": "/v1/Account/{auth_id}/Endpoint/87654322/",
      "created_at": "2025-10-26T14:20:00Z",
      "updated_at": "2025-10-26T14:20:00Z"
    }
  ]
}
Note: The response includes both registered and unregistered endpoints. Registered endpoints have sip_contact, sip_expires, and sip_user_agent populated, while unregistered endpoints have these fields set to null.

​
Examples

​
cURL - List All Endpoints

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/?limit=20&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
cURL - Filter by Username

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/?username__contains=john" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Build Endpoint Dashboard

JavaScript Example
async function getEndpointDashboard() {
  const response = await fetch(
    'https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/',
    {
       headers: {
         'X-Auth-ID': '{auth_id}',
         'X-Auth-Token': '{access_token}'
       }
     }
  );

  const data = await response.json();

  const dashboard = {
    total: data.meta.total_count,
    registered: data.objects.filter(ep => ep.sip_registered === 'true').length,
    unregistered: data.objects.filter(ep => ep.sip_registered === 'false').length,
    endpoints: data.objects.map(ep => ({
      id: ep.endpoint_id,
      alias: ep.alias,
      username: ep.username,
      registered: ep.sip_registered === 'true',
      expires: ep.sip_expires || null
    }))
  };

  return dashboard;
}

getEndpointDashboard().then(console.log);
Use Cases:
  • Build endpoint management dashboards
  • Monitor registration status across all endpoints
  • Audit endpoint configurations and attached applications
  • Identify unregistered endpoints for troubleshooting
  • Filter endpoints by username or alias for quick searches

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Query Parameters

​
limit
integer
default:20
Required range: x <= 100
​
offset
integer
default:0
​
username__contains
string
​
username__exact
string
​
username__startswith
string
​
alias__contains
string
​
alias__exact
string
​
application_id__exact
integer
​
application_id__isnull
boolean
​
sub_account
string

Response

200 - application/json

List of endpoints

​
api_id
string
required
​
meta
object
required
​
objects
object[]
required