List all Endpoints

Retrieve a paginated list of all SIP endpoints in your account.

This API allows you to retrieve a list of all endpoints configured in your account. The response includes complete details for each endpoint, including registration status and attached applications.

Authentication Required:

• Bearer Token: Include your access token in the Authorization header
• X-Auth-ID Header: Your account ID (e.g., {Auth_ID})

HTTP Request

GEThttps://api.vobiz.ai/api/v1/Account/{authID}/Endpoint/

Base URL:

https://api.vobiz.ai/api/v1

Query Parameters

Request Parameters

Name	Type	Description
`limit`	integer	Number of results per page (max 100, default: 20)
`offset`	integer	Number of results to skip (default: 0)
`username__contains`	string	Filter by username (partial match)
`username__exact`	string	Filter by exact username
`username__startswith`	string	Filter by username prefix
`alias__contains`	string	Filter by alias (partial match)
`alias__exact`	string	Filter by exact alias
`application_id__exact`	integer	Filter by application ID
`application_id__isnull`	boolean	Filter endpoints without application
`sub_account`	string	Filter by sub-account auth_id

Response

Returns a dictionary with an objects property that contains an array of Endpoint objects, along with a meta object containing pagination information.

Response - 200 OK

{
  "api_id": "550e8400-e29b-41d4-a716-446655440000",
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 45
  },
  "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: {
        'Authorization': 'Bearer {access_token}',
        'X-Auth-ID': '{Auth_ID}'
      }
    }
  );

  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

Update an Endpoint

Call Detail Records