This guide will help you configure and utilize Team GPS Open APIs, allowing third-party applications to extract and use your Team GPS data. The article covers the following topics:

TABLE OF CONTENTS

• Key generation and authentication

• API Testing using Swagger
• Pagination
• Error Codes and Handling

Key generation and authentication

To access the Team GPS API, you need an API key. Follow these steps to generate your key:

1. Log in as an Admin or Integrations Admin user: Ensure you have the appropriate permissions to access API settings.
   
   
2. Navigate to:
   Admin Settings > Integrations > Public APIs.
   
   
    
   
   
3. Enable Public APIs by toggling the Enable option.
   • A confirmation message will appear; click Yes to activate.
     
     

     
     
      

     
      
     
     
4. Click the Generate Key button.
   
   
    
   
   
5. Name your key.
   • Best Practice: Name the key after the tool with which you’re integrating (e.g., "Power BI Integration").
     
     
      
     
     
6. Copy or download the generated key.

   Note: This is a secret key and will only be shown once for security reasons. If you lose it, you will need to generate a new key.

API Testing using Swagger

1. Access API Documentation:
   Visit the following link to view the API documentation:
   https://api.team-gps.net/open-api/v1/swagger/
2. Authorize the API:
   On the documentation page, click on Authorize, paste your API key into the Value field, then click Authorize followed by Close.
   
   
3. Retrieve CSAT Data:

   • Select  CSAT API ( GET/csat/csat-list) and click on Try it out

   • Fill in parameters (optional):
     
     

     Parameter	Type	Description	Default Value
     page	string	The page number to fetch.	1
     page_size	string	The number of reviews per page.	10
     from_submitted_date	string	Start date filter (format: YYYY-MM-DD).	-
     to_submitted_date	string	End date filter (format: YYYY-MM-DD).	-

     

     
     
     
     
4. Once you have added the parameters you can click on Execute option to view your CSAT review list.
5. Once you execute, you will see the requested data in the response body:

• Response example:

200 OK Response for CSAT Reviews:

{

  "message": "CSAT reviews fetched successfully.",

  "data": {

    "current": 1,

    "total": 80,

    "total_pages": 8,

    "results": [

      {

        "id": 227676,

        "rating": "Positive",

        "comment": "The resolution was quick!",

        "company": "BlueWeb, Company",

        "contact_name": "Amit Mak",

        "contact_email": "amit.mak1995@yahoo.com",

        "submitted_date": "2025-07-01T16:05:15.215272Z",

        "team_members": [

          {

            "is_internal_user": true,

            "identifier": "ronan.thakur",

            "full_name": "michelle stark",

            "email": "mstark@yopmail.com",

            "departments": [

              "Software Developement"

            ],

            "manager": {

              "name": "Alex Bines",

              "email": "alex.bines@yopmail.com"

            }

          }

        ],

        "ticket_id": "3690",

        "ticket_type": "ServiceTicket",

        "ticket_name": "Monthly Feedback for Lawren For the Month of June",

        "tags": [

          "Helpfulness",

          "Knowledge"

        ],

        "ticket_queue": "Professional Services",

        "site": "Main",

        "source": "Ticket",

        "has_marketing_permission": true,

        "is_published": false,

        "psa_tool": "Connectwise",

        "departments": [

          "Software Developement"

        ],

        "managers": [

          {

            "email": "alex.bines@yopmail.com",

            "name": "Alex Bines"

          }

        ]

      },

Pagination

Team GPS APIs support pagination to handle large data sets. Use the following parameters:

• page: Specify the page number.
• page_size: Number of items per page.

Example:

GET https://api.teamgps.com/v1/csat-reviews?page=2&page_size=50

Error Codes and Handling

Common API errors include:

Example Error Response (401 Unauthorized):

{

  "message": "Invalid API key."

}

Other response code examples:

Note: For detailed explanation of error codes refer Swagger documentation request.