Endpoint reference

Authenticate with email and password.

Returns an access token, refresh token, user record and a password_must_change flag.

Blacklist the presented token and end the session.

Exchange a refresh token for a new access token.

Send a password reset email.

Complete a password reset using an emailed token.

Return the authenticated user.

Authenticate a customer contact and return a client-scoped token pair.

End the client session and blacklist the token.

Refresh a client access token.

Send a client password reset email.

Complete a client password reset.

Also the account-activation path.

Self-register a client account.

With a ticket number, activates instantly after verifying the requester email matches; without one, emails an activation link and returns a uniform response that cannot be used to enumerate accounts.

Return the masked requester address for a ticket number.

Used to hint the correct sign-in address on the registration form.

Microsoft 365 OAuth completion landing endpoint.

Health probe returning status, timestamp and version.

Rate-limit exempt.

Metrics in Prometheus exposition format.

Protected by METRICS_TOKEN when set. Rate-limit exempt.

List the contact's company's tickets.

Supports page, per_page (max 100) and status.

Return a single ticket with its conversation and attachments.

Internal notes are removed server-side. Company ownership is verified; mismatches are audit-logged and return 404.

Create a ticket.

Body: subject, description, optional priority, optional attachments[].

Add a reply to a ticket.

Optionally with CC addresses and attachments[]. Reopens pending tickets, refuses closed tickets and notifies the assigned agent.

Stream an attachment inline after ownership verification.

Download an attachment after ownership verification.

List visible categories containing at least one accessible article.

Search and list accessible knowledge base articles.

Supports search, category_id, limit, offset.

Return a single accessible article.

List and filter tickets.

Filters: status (comma-separated), priority, assigned_to (accepts unassigned), requester_email, customer_id (comma-separated), source, search, tags, date_from, date_to, date_field (created_at / updated_at / resolved_at / closed_at / sla_due_at), limit (max 100), offset, order_by, order_dir.

Return a single ticket with its relations.

Look up a ticket by its human-readable ticket number.

Create a ticket.

Requires subject and a valid requester_email. Optional status, priority, description, source, assigned_to, customer_id. An unknown source auto-registers. A description becomes the opening message. Assignment triggers a notification email.

Update ticket fields.

Delete a ticket.

Assign or unassign a ticket.

Body: user_id (nullable). Notifies the new assignee.

Link or unlink the ticket's company.

Body: customer_id (nullable).

Change a ticket's status.

Fires customer and agent notifications plus the admin side-channel.

Change a ticket's priority.

List a ticket's tags.

Add a tag to a ticket.

Remove a tag from a ticket.

Send a reply on a ticket.

Accepts JSON or multipart/form-data with body, is_html, internal_note, cc (JSON array) and attachments[]. Persists the message, resolves and records CCs, uploads attachments, emails the customer with attachments included, stamps first_response_at, and returns granular delivery status (email_sent, email_error, email_error_code). Enforces AI-agent reply permissions.

Archive a ticket to the spam table and hard-delete the original.

The spam record keeps the full ticket detail.

Return the full conversation thread for a ticket.

Create a message on a ticket.

message_type is one of customer_reply, agent_reply, internal_note, system. Sender identity is derived from the authenticated user when not supplied, preventing sender spoofing, while explicit values remain available to the sync workers posting on a customer's behalf. Bumps the ticket's updated_at and dispatches ticket.new_message for agent and customer replies.

Return a single message.

Update a message.

Delete a message.

List a message's attachments.

Attach files to a message.

Full-text search across message bodies.

Download an attachment through the proxy.

Never exposes a public storage URL.

Delete an attachment from storage and the database.

List and search companies.

Supports per_page, is_active, search and industry filters. Returns contact and ticket counts.

Return a single company with its contacts.

Create a company.

Update a company.

Soft-delete a company.

List the contacts for a company.

Create a contact under a company.

List and filter all contacts across companies.

Return a single contact.

Update a contact.

Soft-delete a contact.

List staff users.

Create a staff user.

Body: email, names, password, role, active flag, AI-agent flags.

Update a user.

Delete a user.

Set a temporary password for a user.

Flags password_must_change and optionally emails the user.

Update your own profile.

Change your own password.

Upload your avatar to object storage.

List all roles with display names, descriptions and permission lists.

Return one role's metadata.

Return the caller's effective permissions.

Test whether the caller holds a single permission.

Test several permissions at once.

List and filter articles.

Filters: status, category_id, author_id, is_featured, search, tag_id, visibility, can_edit_role, limit, offset, order_by, order_dir.

Return a single article, with permission checking.

Return a single article by slug.

Create an article.

Requires category_id, title, body_html. Auto-generates a unique slug, plain-text body and excerpt. Accepts tags and company_ids.

Update an article.

Delete an article.

Publish an article and stamp published_at.

Return an article to draft.

Record a helpful vote.

Record a not-helpful vote.

List categories.

Return the full nested category tree.

Return a single category.

Return a category by slug.

Return the ancestor chain for a category.

Create a category.

Body: name, slug, description, parent, visibility, company assignments.

Update a category.

Delete a category.

Bulk reorder categories.

Re-parent a category.

List media library images.

Upload an image to the media library.

Multipart upload; CSRF-exempt for the upload form.

Serve an image through the authenticated proxy.

Delete an image.

Return summary statistics, status and priority distributions, volume trend, dual SLA compliance, response-time distribution and source distribution.

Accepts date_from, date_to and the shared filter set (status, priority, source, agent_id, customer_id).

Return agent performance, leaderboard, workload and optional per-agent detail.

Return customer statistics, top customers and optional per-customer detail.

Return contact-level ticket statistics.

Return per-source volumes and trend over time.

Return the available filter options (active agents, customers, statuses) for building filter UIs.

Export a report as CSV.

type selects the report; the same filters as the on-screen report are applied.

Return policies, business hours, holidays and digest configuration in one call.

Update per-priority first-response and resolution targets in minutes.

Validates priority values and enforces a one-minute minimum.

Set the timezone and per-weekday enabled/open/close windows.

The timezone is validated against the system timezone list.

Add a named non-working date.

Remove a holiday.

Configure weekly and monthly digests and their recipients.

List the five event types with enabled state and descriptions.

Enable or disable an event.

List the recipients for one event.

Add a recipient to an event.

Update a recipient.

Remove a recipient.

Return notification settings such as the daily report time.

Update notification settings.

Send a test notification for an event.

List configured inbound mailboxes.

Return a single inbound source.

Create a Microsoft 365 or IMAP inbound source.

Body: name, type, mailbox/credentials, sync folder, sync interval, mark-as-read, color, active flag. Credentials are encrypted at rest.

Update an inbound source.

Soft-delete an inbound source.

Mark a source as the default.

Clears the previous default.

Run a live connection test.

Checks DNS resolution, port connectivity and authentication.

Start this source's sync worker.

Stop this source's sync worker.

Return the current active sending configuration.

Save the sending configuration.

Microsoft 365 or SendGrid; From address and name, reply-to, domain.

Verify the provider credentials.

Check the sending domain's DNS records.

Send a real test email.

Remove a sending configuration.

Begin the OAuth flow via the broker.

Return the connection status.

List the mailboxes the connected account can access.

Force a token refresh.

Disconnect the account.

Test the Graph connection.

Update the mailbox configuration.

Return per-source and aggregated worker health.

Alive state, heartbeat age, last sync, start time, error count, emails today/session/lifetime, last error, last check.

Start the sync worker.

Stop the sync worker.

Restart the sync worker.

Return the recent worker error history.

List all registered workers with their intended and actual running state.

Return one worker's state.

Start a worker.

Optionally overrides the worker's configuration.

Stop a worker.

List the channel vocabulary with colors.

Add a source label.

Rename or recolor a source label.

Remove a source label.

Return the current color scheme and branding settings.

Public so login pages can theme themselves.

Save colors and branding.

Restore the default appearance.

Upload a client-portal logo.

Serve a stored logo through the proxy.

Return the business information used across all templates.

Update the business information.

List all email templates.

Return one template by ID.

Return one template by key.

For example ticket_reply.

Create a custom template.

Update a template's subject and body.

Delete a custom template.

Render a preview with live merge data.

Restore the shipped default template.

Return a filterable audit log listing.

Return the complete change history for one record.

Return one user's activity.

Return the recent activity feed.

Return aggregated statistics, groupable by action.

Export audit logs to CSV.

Apply a retention policy to the audit log.

Create an API token.

Body: name, optional expires_in_days (1–365). Returns the plaintext once. Restricted to Super Admin and Agent.

List your tokens.

Never returns the plaintext.

Return token metadata.

Revoke a token without deleting its record.

Delete a token.

Verify that an API key works.

Return a user-scoped CSRF token.

Return a session-scoped CSRF token for pre-login forms.

Return the CSRF configuration.

Whether enforcement is enabled and the header name.