REST API

Administrators create bearer tokens with defined scopes for external applications.

Overview

This page explains how to use REST API and describes its main effects. Test changes in a test environment first whenever they may affect existing tickets, permissions, notifications, or automations.

Typical workflow

  1. Search for a user for the token. Use the available search, filter, and detail views. Clear or change filters if expected records do not appear.

  2. Create a token with a label and scopes. Open the relevant administration or action form, enter the required values, and save only after checking assignments and required fields.

  3. Store the token value securely. Perform the function in the designated form and immediately verify the result in the corresponding overview or on the affected ticket.

  4. Deactivate a token. First check which existing records or users are affected. Where possible, deactivate entries instead of deleting them permanently.

  5. Understand request logging and idempotency. Perform the function in the designated form and immediately verify the result in the corresponding overview or on the affected ticket.

  6. Open the OpenAPI description. Perform the function in the designated form and immediately verify the result in the corresponding overview or on the affected ticket.

Notes

  • Visible menu items and actions depend on the signed-in agent’s group and program permissions.

  • Deactivated entries are often retained for existing tickets and reports, but are no longer available for new assignments.

  • After making changes, test at least one realistic use case with a user in the affected role.

REST API