Request API Access
Email support@connectionsonline.net to request an API token for your organization. Include your organization name and intended use.
Include the Token in Every Request
Add your JWT token to the Authorization header of each request:
Identify Your Organization
Most endpoints require an orgId, siteId, or database identifier.
Contact support if you are unsure which values apply to your organization.
Make Your First Request
Try retrieving organization details — go to
API Endpoints
and search for Organization.
Handle Responses and Errors
A 200 OK means success. For anything else, see the
Errors & Troubleshooting page.
Authorization Header
Example cURL Request
Common Authentication Errors
- 401 Unauthorized — Token is missing, expired, or malformed.
- 403 Forbidden — Token is valid but the account lacks permission for this resource.
Get All Users for a Site
Retrieve the full list of users belonging to a specific site or organization.
GET /api/UserGet Departments
List all departments within an organization for reporting or directory purposes.
GET /api/DepartmentGet Dialogs
Retrieve completed or in-progress dialogs for a user or organization.
GET /api/DialogGet Dialog Templates
Retrieve the dialog templates configured for an organization.
GET /api/DialogTemplateExport User Report
Pull user performance or activity data for reporting and integration exports.
GET /api/UserReportSearch
Search for users, dialogs, or other resources across the organization.
GET /api/SearchUnauthorized
The request is missing a valid API token, or the token has expired.
Ensure the Authorization: Bearer header is present and the token is current.
Forbidden
The token is valid but the account does not have permission to access this resource. Contact support to verify your access level.
Not Found
The requested organization, database, user, dialog, or resource does not exist. Verify that all IDs and path parameters are correct.
Too Many Requests
You have sent too many requests in a short period. Wait a moment before retrying, or reduce the frequency of automated requests.
Server Error
An unexpected error occurred on the server. If it persists, contact support@connectionsonline.net with the request details and timestamp.