Retrieve an Endpoint

Get detailed information about a specific endpoint including registration status.

This API allows you to retrieve the details of an existing endpoint. The response includes all endpoint attributes and, if the endpoint is currently registered on a SIP client, additional registration details.

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/{endpointID}/

Base URL:

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

Note: No request parameters are required for this endpoint.

Response

Returns an Endpoint object if valid parameters were provided. Returns 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@sip.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

Delete an Endpoint

Update an Endpoint