List Apps

Retrieve all SFVoPI applications for your organization. Returns apps sorted by creation date (newest first).

Authentication Required

Requires X-API-Key header. See Authentication for details.

HTTP Request

GET /sfvopi/apps

Request Parameters

This endpoint does not accept any query parameters or request body. It returns all apps for the authenticated organization.

Code Examples

cURL

curl -X GET https://prod-api.superfone.co.in/superfone/sfvopi/apps \
  -H "X-API-Key: your_api_key_here"

JavaScript

const response = await fetch('https://prod-api.superfone.co.in/superfone/sfvopi/apps', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
});

const result = await response.json();
console.log(result.data);

TypeScript

interface SfvopiApp {
  app_id: string;
  org_id: number;
  name: string;
  answer_url: string;
  answer_method: 'POST' | 'GET';
  hangup_url: string | null;
  hangup_method: 'POST' | 'GET';
  fallback_answer_url: string | null;
  fallback_answer_method: 'POST' | 'GET';
  status: 'ACTIVE' | 'INACTIVE';
  created_by: number | null;
  created_at: string;
  updated_at: string | null;
}

interface ApiResponse<T> {
  data: T;
  message: string;
}

const response = await fetch('https://prod-api.superfone.co.in/superfone/sfvopi/apps', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
});

const result: ApiResponse<SfvopiApp[]> = await response.json();
console.log(result.data);

Python

import requests

url = 'https://prod-api.superfone.co.in/superfone/sfvopi/apps'
headers = {
    'X-API-Key': 'your_api_key_here'
}

response = requests.get(url, headers=headers)
result = response.json()
print(result['data'])

Success Response

Status Code: 200 OK

{
  "data": [
    {
      "app_id": "sfv_app_abc123xyz456",
      "org_id": 12345,
      "name": "Production Voice App",
      "answer_url": "https://example.com/webhook/answer",
      "answer_method": "POST",
      "hangup_url": "https://example.com/webhook/hangup",
      "hangup_method": "POST",
      "fallback_answer_url": "https://example.com/webhook/fallback",
      "fallback_answer_method": "POST",
      "status": "ACTIVE",
      "created_by": 67890,
      "created_at": "2026-02-02T10:30:00.000Z",
      "updated_at": "2026-02-02T14:15:00.000Z"
    },
    {
      "app_id": "sfv_app_def789ghi012",
      "org_id": 12345,
      "name": "Test Voice App",
      "answer_url": "https://test.example.com/webhook/answer",
      "answer_method": "POST",
      "hangup_url": null,
      "hangup_method": "POST",
      "fallback_answer_url": null,
      "fallback_answer_method": "POST",
      "status": "INACTIVE",
      "created_by": 67890,
      "created_at": "2026-02-01T09:00:00.000Z",
      "updated_at": null
    }
  ],
  "message": "success"
}

Response Fields

The response contains an array of app objects. Each app has the following fields:

Field	Type	Description
app_id	string	Unique identifier for the app (format: sfv_app_xxxxxxxxxxxx)
org_id	number	Organization ID that owns this app
name	string	App name
answer_url	string	Webhook URL for answered calls
answer_method	string	HTTP method for answer webhook (POST or GET)
hangup_url	string | null	Webhook URL for call hangup events
hangup_method	string	HTTP method for hangup webhook
fallback_answer_url	string | null	Fallback webhook URL
fallback_answer_method	string	HTTP method for fallback webhook
status	string	App status (ACTIVE or INACTIVE)
created_by	number | null	User ID who created the app
created_at	string	ISO 8601 timestamp of creation
updated_at	string | null	ISO 8601 timestamp of last update

Sorting

Apps are returned in descending order by created_at (newest first).

No Pagination

This endpoint returns all apps for your organization. There is no pagination.

Error Responses

Status Code	Message	When It Occurs
401	UnAuthorized, Please Provide Valid API Key	Missing or invalid X-API-Key header
500	Failed to get SFVoPI apps: {error}	Server error while fetching apps

Example Error Response

{
  "message": "UnAuthorized, Please Provide Valid API Key"
}

Use Cases

Filter Active Apps

const response = await fetch('https://prod-api.superfone.co.in/superfone/sfvopi/apps', {
  headers: { 'X-API-Key': 'your_api_key_here' }
});

const result = await response.json();
const activeApps = result.data.filter(app => app.status === 'ACTIVE');
console.log(`Active apps: ${activeApps.length}`);

Find App by Name

const response = await fetch('https://prod-api.superfone.co.in/superfone/sfvopi/apps', {
  headers: { 'X-API-Key': 'your_api_key_here' }
});

const result = await response.json();
const myApp = result.data.find(app => app.name === 'Production Voice App');
console.log(myApp?.app_id);

Related Endpoints

• Create App — Create a new app
• Get App — Retrieve a specific app by ID
• Update App — Modify app configuration
• Delete App — Remove an app