Businesses

Get business

Retrieve complete business information including metadata and application configuration.

GET /api/v1/business/{businessId}

Path parameters

integer

required

The unique identifier for the business

Response

Returns a business object with metadata and application configuration.

boolean

Indicates whether the request was successful

object

The business data object

Show BusinessData properties

integer

Unique business identifier

string

Email of the business owner

string

Business name

string

Pre-signed URL for the business logo (valid for 24 hours)

string

Default language code for the business

array

Array of supported language codes

object

Tutorial completion status

object

Business module permissions

string

Email of white label customer if applicable

Show BusinessApp properties

integer

Application identifier

object

Global context configuration

array

Available tools and integrations

array

Array of configured AI agents

Show Agent properties

string

Unique agent identifier

object

General agent configuration

object

Agent-specific context

object

Personality and tone settings

object

Predefined responses and greetings

object

Interruption handling configuration

object

Knowledge base settings

object

Agent integrations (STT, LLM, TTS)

object

Caching configuration

object

Advanced agent settings including background audio URL

array

Conversation scripts

array

Business-level integrations

Show Integration properties

string

Integration identifier

string

Integration type (e.g., STT, LLM, TTS, webhook)

string

Human-readable integration name

object

Integration configuration fields

array

Phone numbers using this integration

object

Business-level caching settings

array

Call routing rules

array

Configured phone numbers

array

Knowledge base configurations

array

Outbound telephony campaigns

array

Web-based campaigns

array

Post-call analysis configurations

string

Error code if Success is false

string

Error message if Success is false

Example request

curl https://api.iqra.ai/api/v1/business/12345 \
  -H "Authorization: Token YOUR_API_KEY"

const response = await fetch('https://api.iqra.ai/api/v1/business/12345', {
  headers: {
    'Authorization': 'Token YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

response = requests.get(
    'https://api.iqra.ai/api/v1/business/12345',
    headers={'Authorization': 'Token YOUR_API_KEY'}
)

data = response.json()

Example response

{
  "Success": true,
  "Data": {
    "BusinessData": {
      "Id": 12345,
      "MasterUserEmail": "user@example.com",
      "Name": "My Business",
      "LogoUrl": "https://s3.amazonaws.com/...",
      "DefaultLanguage": "en",
      "Languages": ["en", "es", "fr"],
      "Tutorials": {},
      "Permission": {
        "MakeCall": true,
        "Conversations": {
          "ConversationPermissions": true,
          "Outbound": true,
          "Inbound": true
        }
      }
    },
    "BusinessApp": {
      "Id": 12345,
      "Context": {},
      "Tools": [],
      "Agents": [
        {
          "Id": "agent_abc123",
          "General": {
            "Name": "Sales Agent",
            "Description": "Handles sales inquiries"
          },
          "Settings": {
            "BackgroundAudioUrl": "https://s3.amazonaws.com/..."
          }
        }
      ],
      "Integrations": [],
      "Numbers": [],
      "TelephonyCampaigns": []
    }
  }
}

Permissions required

This endpoint requires:

Valid API key with access to the specified business
User account must not be disabled
Business must not be disabled
API key must not have business restrictions, or must include this business ID

Notes

Logo URLs and background audio URLs are pre-signed and expire after 24 hours
The response includes complete business configuration including all agents, integrations, and campaigns
Encrypted integration fields are excluded from the response for security

FlowApp System

API Reference

Advanced

Get business

Path parameters

Response

Example request

Example response

Permissions required

Notes

​Get business

​Path parameters

​Response

​Example request

​Example response

​Permissions required

​Notes

Get business

Path parameters

Response

Example request

Example response

Permissions required

Notes