[FOR GLOBAL ADMINS] Using API in Teamflect: A Guideline

Teamflect has an API Keys feature that allows companies to integrate their systems and streamline their processes. This guide will walk you through the steps of utilizing this API feature effectively. 

Step 1: Generating an API Key

Before you begin, please note that this feature is currently accessible only to global administrators. To get started with Teamflect's API feature, you'll need to generate an API key. This key will serve as your authentication token when making API calls. Follow these steps to generate your API key:

  1. Log in to your Teamflect Admin Center account at https://admin.teamflect.com
  2. In the left-hand menu, locate and click on the "API Keys" section.

Within the API section, you'll find an option to generate a new API key. Once generated, be sure to securely store the API key, as it will be required for making authenticated API requests.

Step 2: Accessing Documentation

Understanding how to structure API requests and interact with different endpoints is crucial to successfully utilizing Teamflect's API feature. The documentation provides detailed information about each endpoint, the required parameters, and the expected responses. 

To access the documentation:

  1. Visit the Teamflect API Documentation
  2. In the documentation, you will find a breakdown of available endpoints along with descriptions of their functionalities.
  3. Each endpoint description will outline the required data to be sent, the expected data format, and any optional parameters.

Make sure to read through the documentation thoroughly to gain a comprehensive understanding of how the API works and how you can leverage it to meet your company's needs.

Still need help? Contact Us Contact Us