Skip to main content
GET
List All Endpoints
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

Response

Returns a dictionary with an objects array of Endpoint objects and a meta object with pagination information.
Response - 200 OK
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 - Filter by Username

cURL Request

Build Endpoint Dashboard

JavaScript Example
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

Offset-based pagination metadata returned in the meta object of the Application, Endpoint and Recording list endpoints. To fetch the next page, add limit to offset, or request the next URL as-is.

objects
object[]
required