User

The User API provides access to the authenticated user’s profile data, including personal account details, white-label configuration, and branding assets.

Get user data

Retrieve the complete profile of the authenticated user.

GET /api/v1/user

This endpoint returns comprehensive user information including:

Personal account details (email, name, permissions)
White-label configuration (logos, icons, custom domains)
S3 pre-signed URLs for branding assets
Account status and subscription information

Authentication

This endpoint requires API key authentication. The API key must have user access management permissions enabled.

Request

No request body is required. Authentication is provided via the Authorization header. Example request:

curl -X GET https://app.iqra.bot/api/v1/user \
  -H "Authorization: Token YOUR_API_KEY"

const response = await fetch('https://app.iqra.bot/api/v1/user', {
  method: 'GET',
  headers: {
    'Authorization': 'Token YOUR_API_KEY'
  }
});

const userData = await response.json();
console.log(userData);

import requests

response = requests.get(
    'https://app.iqra.bot/api/v1/user',
    headers={
        'Authorization': 'Token YOUR_API_KEY'
    }
)

user_data = response.json()
print(user_data)

Response

boolean

Whether the request succeeded

object

User data object

Show User data structure

string

Unique user identifier

string

User’s email address

string

User’s display name

boolean

Whether the account is disabled

object

User permission flags

object

White-label configuration for branding

Show White-label properties

string

Custom domain for branded dashboard

string

Pre-signed URL for the logo image

string

Pre-signed URL for the favicon

string

Primary brand color (hex format)

object

Subscription and billing information

Show Subscription properties

string

Current subscription plan

string

Subscription status: active, trialing, past_due, canceled

string

End of current billing period (ISO 8601)

string

Account creation timestamp (ISO 8601)

string

Last update timestamp (ISO 8601)

Example response:

{
  "success": true,
  "data": {
    "id": "user_abc123",
    "email": "user@example.com",
    "name": "John Doe",
    "isDisabled": false,
    "permissions": {
      "canCreateBusinesses": true,
      "canManageApiKeys": true
    },
    "whiteLabel": {
      "customDomain": "voice.mycompany.com",
      "logoUrl": "https://s3.amazonaws.com/...",
      "iconUrl": "https://s3.amazonaws.com/...",
      "brandColor": "#2563EB"
    },
    "subscription": {
      "plan": "professional",
      "status": "active",
      "currentPeriodEnd": "2026-04-01T00:00:00Z"
    },
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2026-03-01T14:20:00Z"
  }
}

Use cases

Profile display

Show user profile information in your application

White-label branding

Apply custom branding from user’s white-label configuration

Permission checks

Verify user permissions before allowing actions

Account status

Display subscription status and account health

Error codes

Code	Description
`INVALID_API_KEY`	The API key is invalid or expired
`USER_DISABLED`	The user account has been disabled
`PERMISSION_DENIED`	API key lacks user access management permissions

Notes

All responses return HTTP 200. Check the success field in the response body to determine if the operation actually succeeded.

S3 pre-signed URLs for branding assets expire after a set period (typically 1 hour). Cache the URLs but be prepared to refresh them when they expire.

This endpoint is only available in self-hosted deployments. The Iqra Cloud platform manages user data through the dashboard interface.

User Usage API - Retrieve usage metrics and billing history
Authentication - API key management
Businesses API - Manage business accounts

FlowApp System

API Reference

Advanced

Get user data

Authentication

Request

Response

Use cases

Profile display

White-label branding

Permission checks

Account status

Error codes

Notes

​Get user data

​Authentication

​Request

​Response

​Use cases

Profile display

White-label branding

Permission checks

Account status

​Error codes

​Notes

​Related endpoints

Get user data

Authentication

Request

Response

Use cases

Error codes

Notes

Related endpoints