Skip to main content

Quick Start Guide

Get started with COMPASS API in just a few minutes. This guide will walk you through the essential steps to make your first API calls and understand the core concepts.

Prerequisites

  • OAuth Provider: Google or Microsoft account
  • HTTP Client: Postman, curl, or any programming language
  • Base URL: http://localhost:2000

Step 1: Get Your Authentication Token

Option A: Using Google OAuth

  1. Get Authorization Code
    • Navigate to Google OAuth consent screen
    • Receive authorization code after user consent
  2. Exchange for JWT Token

Option B: Using Microsoft OAuth

  1. Get Authorization Code
    • Navigate to Microsoft OAuth consent screen
    • Receive authorization code after user consent
  2. Exchange for JWT Token
Response:

Step 2: Make Your First API Call

Use the token from Step 1 to access protected endpoints:
Response:

Step 3: Explore Core Features

Get Available Permissions

List Departments

Get Email Statistics

Step 4: Try Advanced Features

Create a New Department

Get HubSpot Ticket Filters

Generate Audio Transcription

Code Examples

JavaScript/Node.js

Python

React Component

Common Use Cases

1. User Management Dashboard

2. Email Analytics Report

3. Ticket Management System

Testing Your Integration

Using Postman

  1. Import Collection
    • Create new collection
    • Set base URL: http://localhost:2000
    • Add authorization variable: {{token}}
  2. Authentication Request
    • Method: POST
    • URL: /auth/signin-google/{{authCode}}
    • Save token to collection variables
  3. Test Request
    • Method: GET
    • URL: /users/profile
    • Headers: Authorization: Bearer {{token}}

Using curl Script

Next Steps

Now that you’ve completed the quick start:
  1. Explore Full Documentation - Dive into detailed API references
  2. Build Your Application - Start integrating COMPASS features
  3. Check Permissions - Understand access control system
  4. Review Best Practices - Learn security and performance tips

Need Help?

  • Documentation: Browse our comprehensive guides
  • Examples: Check out our code samples
  • Support: Contact our development team
  • Community: Join our developer forums
Ready to build something amazing? Start exploring our complete API reference!