Get business
Retrieve complete business information including metadata and application configuration.
GET /api/v1/business/{businessId}
Path parameters
The unique identifier for the business
Response
Returns a business object with metadata and application configuration.
Indicates whether the request was successful
The business data objectShow BusinessData properties
Unique business identifier
Email of the business owner
Pre-signed URL for the business logo (valid for 24 hours)
Default language code for the business
Array of supported language codes
Tutorial completion status
Business module permissions
WhiteLabelAssignedCustomerEmail
Email of white label customer if applicable
Show BusinessApp properties
Global context configuration
Available tools and integrations
Array of configured AI agents
General agent configuration
Personality and tone settings
Predefined responses and greetings
Interruption handling configuration
Agent integrations (STT, LLM, TTS)
Advanced agent settings including background audio URL
Business-level integrationsShow Integration properties
Integration type (e.g., STT, LLM, TTS, webhook)
Human-readable integration name
Integration configuration fields
Phone numbers using this integration
Business-level caching settings
Knowledge base configurations
Outbound telephony campaigns
Post-call analysis configurations
Error code if Success is false
Error message if Success is false
Example request
curl https://api.iqra.ai/api/v1/business/12345 \
-H "Authorization: Token YOUR_API_KEY"
Example response
{
"Success": true,
"Data": {
"BusinessData": {
"Id": 12345,
"MasterUserEmail": "[email protected]",
"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