Endpoints
Retrieve an Endpoint
Fetch a Vobiz SIP endpoint by ID - returns live registration status, SIP contact, expiry, user agent string, and attached application details for call routing.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Endpoint
/
{endpoint_id}
/
Retrieve an Endpoint
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}{
"api_id": "<string>",
"error": "<string>",
"message": "<string>"
}GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/
Authentication required:
X-Auth-ID- Your account Auth ID (e.g.,{auth_id})X-Auth-Token- Your account Auth TokenContent-Type: application/json
No request parameters are required for this endpoint.
Response
Returns an Endpoint object for valid parameters, or an error otherwise.Success Response (200 OK)
Response - 200 OK
{
"api_id": "550e8400-e29b-41d4-a716-446655440000",
"endpoint_id": "87654321",
"username": "john_doe",
"alias": "John's Desktop Phone",
"sip_uri": "sip:john_doe@registrar.vobiz.ai",
"sip_registered": "true",
"sip_registration": {
"contact": "192.168.1.100:5060",
"expires": "2025-10-28T11:30:00Z",
"user_agent": "Zoiper v5.4.5",
"received": "203.0.113.42:5060",
"path": null
},
"application": {
"app_id": "12345678",
"app_name": "Customer Service App",
"answer_url": "https://example.com/answer",
"answer_method": "POST"
},
"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"
}
Registration Details: The
sip_registration object contains detailed information about the endpoint’s current SIP registration including contact address, expiration time, user agent, and received address. This object is only present when sip_registered is "true".Error Response (404 Not Found)
Response - 404 Not Found
{
"error": "Endpoint not found",
"endpoint_id": "99999999"
}
Examples
cURL
cURL Request
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/87654321/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
Use Cases:
- Verify endpoint registration status before making calls
- Check which application is attached to an endpoint
- Monitor SIP client registration expiration times
- Retrieve SIP URI for sharing with external users
- View detailed permission settings for an endpoint
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Example:
"87654321"
Was this page helpful?
⌘I
Retrieve an Endpoint
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}{
"api_id": "<string>",
"error": "<string>",
"message": "<string>"
}