Jump to Content
API Reference
v1.4
v1.4.1
API Reference
v1.4
API Reference
Introduction
All
Pages
Start typing to search…
JUMP TO
Introduction
Getting Started With Your API
Authentication
Introduction
Generate Token
post
Validate Token
post
qAuth
Introduction
Organizations
Get All
get
Create
post
Users & RBAC
Introduction
Users
Create User
post
List Users
get
Roles & Permissions
List Permissions
get
List Roles
get
Create New Role
post
Get Role by ID
get
MiniCRM
Introduction
Accounts
Account List
get
Account By Id
get
Update Account
patch
Delete Account
del
Contacts
Update Contact
patch
Insert Many Contacts
post
Create Contact
post
Get All Contacts
get
Search In Contacts
get
Get One Contact By Id
get
Delete Contact
del
Get all fields from accounts and contacts
get
Custom Field
Create Custom Field
post
Update Custom Field
patch
Get Custom Field List
get
Get Custom Field By Id
get
Delete Custom Field By Id
del
Tags
Create Tag
post
Update Tag By Id
patch
Tags List
get
Get Tag By Id
get
Delete Tag By Id
del
Create Tag For Account
post
Delete Tag For Account
del
Create Tag For Contact
post
Delete Tag For Contact
del
Many Contact to tags
Assign Many Contact
post
Unassigned Many Contact To Tag
del
Surveys
Survey Management
Create New Survey
post
Update Survey
patch
Find One Survey
get
Find All Surveys
get
Questions Management
Create Question
post
Update Question
patch
Find One Question
get
Find All Questions
get
Create Answers
post
Reporting API
Find Survey Results
get
Find Survey Results Answers
get
Find Survey Results Report
get
Voice Call
Getting Started With Your API
Initiate Call
post
Queue Statistics
Calls
Call Details
post
By Queues summary
post
By Queues Abandoned
post
By Queues Answered
post
By Queues All
post
Answered Calls List
post
Answered Calls Summary
post
Abandoned Calls List
post
Abandoned Calls Summary
post
By Agent
post
By Agent Answered
post
By Agent Lost
post
By Agent All
post
Lost Call By Agent
post
Summary - Abandoned Calls
post
Summary - Answered Calls
post
Call Reports Summary
post
By Traffic
Lost Calls By Hour
post
Call Traffic By Week Day
post
Call Traffic By Month
post
Call Traffic By Day
post
Call Traffic By Hour
post
Service Level
Service Level - Hold Time
post
Service Level - Ringing Time
post
Qranger (Phonex) Recordings
Download Recording File
get
Play Recording File
get
Recording List
get
qranger (phonex) cdr
Call List Records (CDR)
post
Call Summary Records (CDR)
post
Phone Numbers
List My Phone Numbers
get
Call History
get
webhooks
Call Detailed Records (CDR)
Campaign
Create Campaign
post
Update Campaign By Id
patch
Get All Campaign
get
Get One Campaign By Id
get
Delete Campaign By Id
del
Reporting
Get Campaign report
get
actions
Start campaign
post
CDR
Getting Started With Your API
qAuth v2.0
Auth
Refresh Token
post
Validate Token
post
Organizations
Roles
Create Role
post
List Roles
get
Find Many Roles
post
List Roles for Dropdown
get
List Role
get
Update Role
put
Delete Role
del
Users
List Users
get
List User
get
Find Many Users
post
Create User & Assign Role
post
Update User
put
Delete User
del
Inivitations
List User Invitation
get
Create User by Inivitation
post
Create User Invitation
post
Cancel User Invitation
post
Redirect Invitation Link
get
Custom Fields
Create Custom Field
post
List Custom Fields
get
List Custom Field
get
Update Custom Field
patch
Delete Custom Field
del
API Keys
Create API Key
post
List API Keys
get
List API Key
get
Find Many API Keys
post
Delete API Keys
del
Tenants
Auth
Login
post
Resend OTP (Login)
post
OTP Verify (Login)
post
Forgot Password
post
OTP Verify (Password Reset)
post
Reset Password
post
Change Password
post
Logout
post
Login Histories - Tenant
get
Login Histories - Organization
get
Active Sessions
get
Organizations
Create Organization
post
List Organizations
get
List Organization
get
Find Many Organizations
post
Update Organization
put
Delete Organization
del
API Keys
Create Tenant API Key
post
Delete Tenant API Key
del
Regenerate Tenant Master API Key
post
Roles
Create Built-in Role
post
Update Built-in Role
put
Delete Built-in Role
del
Permissions
Create Permission
post
List Permissions
get
List Permission
get
Find Many Permissions
post
Update Permission
put
Delete Permission
del
Permission Groups
Create Permission Group
post
List Permission Groups
get
List Permission Group
get
Find Many Permission Groups
post
Update Permission Group
put
Delete Permission Group
del
CRM
default
Get Customer Information
get
default
Get Customer Information
get
qOrbit v2.0
Integrations
Get Integrations
get
Create Integration
post
Update Integration
put
Get Integration
get
Delete Integration
del
Connections
Create Connection
post
Get Connections
get
Get Connection Credentials
get
Delete Connection
del
Inbox Service
Test
get
Omnichannel Inbox
/new-endpoint
New Endpoint
get
Call-Center Report
Outgoing Calls
Outgoing Calls Summary
get
Outgoing Call CDRs
get
Abandoned Calls
Abandoned Call Events
get
Abandoned Calls Summary
get
Abandoned Call Statistics
get
Answered Calls
Answered Call Events
get
Answered Calls Summary
get
Answered Call Disconnection Statistics
get
Reports By Queue
Queue Performance Summary
get
Queue Call Events
get
List Calls By Queue
get
Reports By Agent
Lost Calls by Agent
get
Lost Call Events
get
Agent Performance Statistics
get
Agent Call Details
get
Call Reports
Overall Call Center Analytics
get
Get Call Detail Records (CDR)
get
Traffic Analysis
Hourly Call Traffic
get
Daily Call Traffic
get
Weekday Call Traffic
get
Monthly Call Traffic
get
Traffic Analysis
Hourly Lost Call Traffic
get
Reports
Get Agent Names
get
Get Queue Names
get
Powered by
Introduction
Ask AI
This page will help you get started with MiniCRM.
