Applications
List All Applications
List all voice applications on your Vobiz account - paginated results with full configuration for each app_id, including webhook URLs and attached numbers.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Application
/
List All Applications
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/"
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}/Application/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
"meta": {
"limit": 20,
"next": "/v1/Account/MA_XXXXXXXX/Application/?limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 23
},
"objects": [
{
"answer_method": "POST",
"answer_url": "https://example.com/answer",
"app_id": "12345678901234567",
"app_name": "My Voice App",
"application_type": "XML",
"created_at": "2026-04-02 12:11:19.740666+00:00",
"default_app": true,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://example.com/hangup",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:12345678901234567@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-04-02 12:11:19.740666+00:00"
},
{
"answer_method": "POST",
"answer_url": "https://example.com/answer",
"app_id": "11223344556677889",
"app_name": "Acme Voice Application",
"application_type": "XML",
"created_at": "2026-03-25 09:33:08.869648+00:00",
"default_app": false,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://example.com/hangup",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/11223344556677889/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:11223344556677889@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-03-25 09:33:08.869648+00:00"
}
]
}GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/
answer_url, hangup_url, fallback_answer_url, message_url) that Vobiz calls when a call or message reaches a number or endpoint attached to it. This endpoint returns every application on the account as a paginated list, with the full configuration of each one, so you can find an app_id without opening the Console.
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-Type: application/json
When to use it
- Find an
app_idbefore you attach a number to an application or retrieve, update, or delete one. - Audit webhook URLs across all applications, for example to confirm every
answer_urlpoints at your production host. - Find the default application by checking which object has
default_app: true. - Separate main-account and sub-account applications with the
sub_accountfield, which isnullfor applications on the main account.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of results per page (max 100). Defaults to 20. |
offset | integer | No | Number of results to skip. Defaults to 0. |
Pagination
Results are paged withlimit and offset. The meta object in the response tells you where you are in the full list:
meta.total_countis the number of applications on the account, across all pages.meta.nextis the request path for the next page, built from the samelimitand the nextoffset.meta.previousis the path for the previous page. It isnullon the first page.- To read every application, keep
limitfixed and addlimittooffseton each request until you havetotal_countobjects.
Response
A successful request returns200 OK with three top-level fields.
| Field | Type | Description |
|---|---|---|
api_id | string | Identifier for this API request. |
meta | object | Pagination state: limit, offset, total_count, next, and previous. |
objects | array | The applications on this page. Each item is an Application object. |
Application fields
Each item inobjects carries these fields. See The Application Object for the full reference.
| Field | Type | Description |
|---|---|---|
app_id | string | Unique identifier for the application. Use it in all per-application API paths. |
app_name | string | Name of the application. |
application_type | string | Type of application. Typically XML. |
answer_url | string | URL Vobiz fetches when a call executes this application. Must return valid VobizXML. |
answer_method | string | HTTP method for answer_url, GET or POST. |
hangup_url | string | URL notified when the call ends. |
hangup_method | string | HTTP method for hangup_url, GET or POST. |
fallback_answer_url | string (nullable) | Backup URL used only when answer_url is unreachable, times out, or returns invalid VobizXML. |
fallback_method | string | HTTP method for fallback_answer_url. |
message_url | string (nullable) | URL notified when an inbound message is received. |
message_method | string | HTTP method for message_url. |
log_incoming_message | boolean | Whether incoming messages to numbers on this application are logged. |
default_app | boolean | Whether this is the account-level default application. |
default_endpoint_app | boolean | Whether new endpoints without an application are routed to this application. |
enabled | boolean | Whether the application is enabled. |
public_uri | boolean | Whether the application’s sip_uri is reachable by external SIP systems. See Public SIP URI. |
sip_uri | string | SIP URI associated with the application. |
sip_transfer_url | string (nullable) | URL notified during a SIP transfer. |
sip_transfer_method | string | HTTP method for SIP transfer callbacks. |
sub_account | string (nullable) | Sub-account auth_id, or null for the main account. |
resource_uri | string | API resource URI for this application. |
created_at | string | Creation timestamp (UTC). |
updated_at | string | Last update timestamp (UTC). |
Errors
| Status | Meaning |
|---|---|
200 | The request succeeded. The body carries api_id, meta, and objects. |
401 | Invalid credentials. Check the X-Auth-ID and X-Auth-Token headers. |
Response Example
Success Response (200 OK)
{
"api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
"meta": {
"limit": 20,
"next": "/v1/Account/MA_XXXXXXXX/Application/?limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 23
},
"objects": [
{
"answer_method": "GET",
"answer_url": "https://example.com/answer",
"app_id": "12345678901234567",
"app_name": "My Voice App",
"application_type": "XML",
"created_at": "2026-04-02 12:11:19.740666+00:00",
"default_app": true,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://example.com/answer",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:12345678901234567@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-04-02 12:11:19.740666+00:00"
},
{
"answer_method": "POST",
"answer_url": "https://yourapp.com/ivr/answer",
"app_id": "23456789012345678",
"app_name": "Acme Voice Application",
"application_type": "XML",
"created_at": "2026-04-17 10:28:50.162012+00:00",
"default_app": false,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://yourapp.com/ivr/hangup",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/23456789012345678/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:23456789012345678@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-04-17 10:28:50.162012+00:00"
}
]
}
cURL Example
cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/?limit=20&offset=0" \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
Authorizations
Response
List of applications
Was this page helpful?
⌘I
List All Applications
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/"
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}/Application/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
"meta": {
"limit": 20,
"next": "/v1/Account/MA_XXXXXXXX/Application/?limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 23
},
"objects": [
{
"answer_method": "POST",
"answer_url": "https://example.com/answer",
"app_id": "12345678901234567",
"app_name": "My Voice App",
"application_type": "XML",
"created_at": "2026-04-02 12:11:19.740666+00:00",
"default_app": true,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://example.com/hangup",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:12345678901234567@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-04-02 12:11:19.740666+00:00"
},
{
"answer_method": "POST",
"answer_url": "https://example.com/answer",
"app_id": "11223344556677889",
"app_name": "Acme Voice Application",
"application_type": "XML",
"created_at": "2026-03-25 09:33:08.869648+00:00",
"default_app": false,
"default_endpoint_app": false,
"enabled": true,
"fallback_answer_url": null,
"fallback_method": "POST",
"hangup_method": "POST",
"hangup_url": "https://example.com/hangup",
"log_incoming_message": true,
"message_method": "POST",
"message_url": null,
"public_uri": false,
"resource_uri": "/v1/Account/MA_XXXXXXXX/Application/11223344556677889/",
"sip_transfer_method": "POST",
"sip_transfer_url": null,
"sip_uri": "sip:11223344556677889@app.vobiz.ai",
"sub_account": null,
"updated_at": "2026-03-25 09:33:08.869648+00:00"
}
]
}