Skip to main content
GET
List All Applications
Returns details of all applications created under your Vobiz account. An application holds the webhook URLs (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 ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

When to use it

  • Find an app_id before 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_url points 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_account field, which is null for applications on the main account.

Parameters

Pagination

Results are paged with limit and offset. The meta object in the response tells you where you are in the full list:
  • meta.total_count is the number of applications on the account, across all pages.
  • meta.next is the request path for the next page, built from the same limit and the next offset.
  • meta.previous is the path for the previous page. It is null on the first page.
  • To read every application, keep limit fixed and add limit to offset on each request until you have total_count objects.

Response

A successful request returns 200 OK with three top-level fields.

Application fields

Each item in objects carries these fields. See The Application Object for the full reference.

Errors

See Error Handling for the shared error format and every status code.

Response Example

Success Response (200 OK)

cURL Example

cURL

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

Response

List of applications

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