Tikit API Documentation

Web Access


You can find the Tikit API Documentation page at https://tikitapi.cireson.com

Details

Many of the common HTTP request endpoints for the Tikit API are documented and organized by the type of request.

The following information for each endpoint is provided, including:

  • Description for each endpoint

  • The full endpoint URL (ex. https://app.tikit.ai/api/Ticket), including the request method (POST, GET, etc.)

  • Sample response schema, payloads, and OData filters

  • Required parameters

  • Ability to execute requests against a Tikit environment, given a valid Authentication Access Token

Usage

In order to test actual requests against your Tikit environment, you need a valid Tikit Access Token

Paste the token in the Authentication Bearer Token field at the top left of the page:

Then click, "Set Token" to Authenticate.

PLEASE NOTE: This will create a live connection to your Tikit instance!
Any methods which manipulate data (ex. POST, PATCH, etc.) will apply. Use caution when testing these endpoints and consider using GET requests for obtaining data for your environment instead of making permanent changes.

The Access Token will be scoped to the role it was configured to use in the Tikit Access Token Settings