Export HubSpot Tickets - COMPASS API Documentation

Export HubSpot tickets list

curl --request POST \
  --url http://localhost:2000/hubspot/tickets/list/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "xlsx",
  "columns": [
    "ticketId",
    "subject",
    "feedbackCategory",
    "agentInvolved",
    "createdAt"
  ],
  "departmentCode": "OPS"
}
'

import requests

url = "http://localhost:2000/hubspot/tickets/list/export"

payload = {
    "format": "xlsx",
    "columns": ["ticketId", "subject", "feedbackCategory", "agentInvolved", "createdAt"],
    "departmentCode": "OPS"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    format: 'xlsx',
    columns: ['ticketId', 'subject', 'feedbackCategory', 'agentInvolved', 'createdAt'],
    departmentCode: 'OPS'
  })
};

fetch('http://localhost:2000/hubspot/tickets/list/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2000",
  CURLOPT_URL => "http://localhost:2000/hubspot/tickets/list/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'format' => 'xlsx',
    'columns' => [
        'ticketId',
        'subject',
        'feedbackCategory',
        'agentInvolved',
        'createdAt'
    ],
    'departmentCode' => 'OPS'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2000/hubspot/tickets/list/export"

	payload := strings.NewReader("{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2000/hubspot/tickets/list/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2000/hubspot/tickets/list/export")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}"

response = http.request(request)
puts response.read_body

"<string>"

POST

hubspot

tickets

list

export

Export HubSpot tickets list

curl --request POST \
  --url http://localhost:2000/hubspot/tickets/list/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "xlsx",
  "columns": [
    "ticketId",
    "subject",
    "feedbackCategory",
    "agentInvolved",
    "createdAt"
  ],
  "departmentCode": "OPS"
}
'

import requests

url = "http://localhost:2000/hubspot/tickets/list/export"

payload = {
    "format": "xlsx",
    "columns": ["ticketId", "subject", "feedbackCategory", "agentInvolved", "createdAt"],
    "departmentCode": "OPS"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    format: 'xlsx',
    columns: ['ticketId', 'subject', 'feedbackCategory', 'agentInvolved', 'createdAt'],
    departmentCode: 'OPS'
  })
};

fetch('http://localhost:2000/hubspot/tickets/list/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2000",
  CURLOPT_URL => "http://localhost:2000/hubspot/tickets/list/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'format' => 'xlsx',
    'columns' => [
        'ticketId',
        'subject',
        'feedbackCategory',
        'agentInvolved',
        'createdAt'
    ],
    'departmentCode' => 'OPS'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2000/hubspot/tickets/list/export"

	payload := strings.NewReader("{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2000/hubspot/tickets/list/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2000/hubspot/tickets/list/export")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"format\": \"xlsx\",\n  \"columns\": [\n    \"ticketId\",\n    \"subject\",\n    \"feedbackCategory\",\n    \"agentInvolved\",\n    \"createdAt\"\n  ],\n  \"departmentCode\": \"OPS\"\n}"

response = http.request(request)
puts response.read_body

"<string>"

Exports HubSpot tickets based on selected filters, columns, and department. The response returns a downloadable file (Excel, CSV, or JSON) depending on the requested format. Requires authentication. If no format is specified, defaults to xlsx.

Request

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token
Content-Type	string	Yes	application/json

Request Body

{
  "format": "xlsx",
  "columns": [
    "ticketId",
    "subject",
    "feedbackCategory",
    "agentInvolved",
    "createdAt",
    "status",
    "priority",
    "passenger_name",
    "chauffeur_name"
  ],
  "departmentCode": "OPS"
}

Request Body Schema

Field	Type	Required	Description
format	string	Yes	Output file format (xlsx, csv, json)
columns	array	Yes	List of ticket fields to include
departmentCode	string	No	Department code to filter tickets

Field Details

format (enum)

xlsx - Microsoft Excel format
csv - Comma-separated values format
json - JSON array format

columns (array of strings)

Available columns include: ticketId, subject, content, feedbackCategory, agentInvolved, status, priority, createdAt, updatedAt, closedAt, departmentCode, passenger_name, passenger_email, passenger_phone, chauffeur_name, chauffeur_id, reservation_id, pickup_location, dropoff_location, scheduled_time, actual_time, delay_minutes, resolution_notes, tags

departmentCode (string)

Must be valid department code in system
Filters exported tickets to specific department
Optional - if omitted, exports all departments

Response

200 OK - Successfully generated export file

Headers:

Content-Type: application/octet-stream
Content-Disposition: attachment; filename="hubspot-tickets-2025-10-01.xlsx"
Content-Length: 12345

Body: Binary file content (Excel, CSV, or JSON format)

400 Bad Request

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request body or validation error"
  }
}

401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid token"
  }
}

500 Internal Server Error

{
  "error": {
    "code": "SERVER_ERROR",
    "message": "Internal server error"
  }
}

Examples

Export to Excel with all columns

curl -X POST 'http://localhost:2000/hubspot/tickets/list/export' \
  -H 'Authorization:Bearerbearer your-jwt-token' \
  -H 'Content-Type: application/json' \
  -d '{
    "format": "xlsx",
    "columns": ["ticketId", "subject", "feedbackCategory", "agentInvolved", "createdAt", "status", "priority"]
  }' \
  --output tickets-export.xlsx

Export to CSV with specific columns

curl -X POST 'http://localhost:2000/hubspot/tickets/list/export' \
  -H 'Authorization oBearerbearer your-jwt-token' \
 \
  -H 'Content-Type: application/json' \
  -d '{
    "format": "csv",
    "columns": ["ticketId", "subject", "passenger_name", "chauffeur_name", "status"],
    "departmentCode": "OPS"
  }' \
  --output tickets-export.csv

Export to JSON format

curl -X POST 'http://localhost:2000/hubspot/tickets/list/export' \
  -H 'Authorization oBearerbearer your-jwt-token' \
 \
  -H 'Content-Type: application/json' \
  -d '{
    "format": "json",
    "columns": ["ticketId", "subject", "feedbackCategory", "agentInvolved", "createdAt"],
    "departmentCode": "OPS"
  }' \
  --output tickets-export.json

Implementation Examples

React Export Component

import React, { useState } from 'react';

function TicketExport() {
  const [exporting, setExporting] = useState(false);
  const [selectedColumns, setSelectedColumns] = useState([
    'ticketId', 'subject', 'feedbackCategory', 'agentInvolved', 'createdAt', 'status'
  ]);
  const [format, setFormat] = useState('xlsx');
  const [departmentCode, setDepartmentCode] = useState('');

  const availableColumns = [
    { value: 'ticketId', label: 'Ticket ID' },
    { value: 'subject', label: 'Subject' },
    { value: 'content', label: 'Content' },
    { value: 'feedbackCategory', label: 'Category' },
    { value: 'agentInvolved', label: 'Agent' },
    { value: 'status', label: 'Status' },
    { value: 'priority', label: 'Priority' },
    { value: 'createdAt', label: 'Created Date' },
    { value: 'passenger_name', label: 'Passenger Name' },
    { value: 'chauffeur_name', label: 'Chauffeur Name' }
  ];

  const handleExport = async () => {
    setExporting(true);
    
    try {
      const response = await fetch('/hubspot/tickets/list/export', {
        method: 'POST',
        headers: {
          'Authorization': `Bearer ${token}`,
          'Content-Type': 'application/json'
        },
        body: JSON.stringify({
          format,
          columns: selectedColumns,
          departmentCode: departmentCode || undefined
        })
      });

      if (!response.ok) {
        throw new Error(`Export failed: ${response.statusText}`);
      }

      // Get filename from Content-Disposition header
      const contentDisposition = response.headers.get('Content-Disposition');
      const filename = contentDisposition 
        ? contentDisposition.split('filename=')[1].replace(/"/g, '')
        : `tickets-export.${format}`;

      // Create blob and download
      const blob = await response.blob();
      const url = window.URL.createObjectURL(blob);
      const a = document.createElement('a');
      a.href = url;
      a.download = filename;
      document.body.appendChild(a);
      a.click();
      window.URL.revokeObjectURL(url);
      document.body.removeChild(a);

    } catch (error) {
      console.error('Export error:', error);
      alert('Export failed. Please try again.');
    } finally {
      setExporting(false);
    }
  };

  return (
    <div className="ticket-export">
      <h3>Export Tickets</h3>
      
      <div className="export-form">
        <div className="form-group">
          <label>Format:</label>
          <select value={format} onChange={(e) => setFormat(e.target.value)}>
            <option value="xlsx">Excel (.xlsx)</option>
            <option value="csv">CSV (.csv)</option>
            <option value="json">JSON (.json)</option>
          </select>
        </div>

        <div className="form-group">
          <label>Department (optional):</label>
          <input 
            type="text" 
            value={departmentCode}
            onChange={(e) => setDepartmentCode(e.target.value)}
            placeholder="e.g., OPS"
          />
        </div>

        <div className="form-group">
          <label>Columns to export:</label>
          <div className="column-selector">
            {availableColumns.map(column => (
              <label key={column.value}>
                <input
                  type="checkbox"
                  checked={selectedColumns.includes(column.value)}
                  onChange={(e) => {
                    if (e.target.checked) {
                      setSelectedColumns([...selectedColumns, column.value]);
                    } else {
                      setSelectedColumns(selectedColumns.filter(col => col !== column.value));
                    }
                  }}
                />
                {column.label}
              </label>
            ))}
          </div>
        </div>

        <button 
          onClick={handleExport} 
          disabled={exporting || selectedColumns.length === 0}
          className="export-button"
        >
          {exporting ? 'Exporting...' : `Export as ${format.toUpperCase()}`}
        </button>
      </div>
    </div>
  );
}

Vue.js Export Function

export default {
  data() {
    return {
      format: 'xlsx',
      columns: ['ticketId', 'subject', 'status'],
      departmentCode: '',
      exporting: false
    };
  },
  methods: {
    async exportTickets() {
      this.exporting = true;
      
      try {
        const response = await fetch('/hubspot/tickets/list/export', {
          method: 'POST',
          headers: {
            'Authorization': `Bearer ${this.token}`,
            'Content-Type': 'application/json'
          },
          body: JSON.stringify({
            format: this.format,
            columns: this.columns,
            departmentCode: this.departmentCode || undefined
          })
        });

        if (!response.ok) throw new Error('Export failed');

        const blob = await response.blob();
        const url = window.URL.createObjectURL(blob);
        const a = document.createElement('a');
        a.href = url;
        a.download = `tickets-export.${this.format}`;
        a.click();
        window.URL.revokeObjectURL(url);

      } catch (error) {
        console.error('Export error:', error);
        this.$emit('error', 'Export failed');
      } finally {
        this.exporting = false;
      }
    }
  }
};

File Format Details

Excel (.xlsx)

Structure: Worksheet with headers in first row
Data Types: Dates formatted as Excel dates, numbers as numbers
Features: Auto-sized columns, formatted headers
Size: Typically smallest for large datasets

CSV (.csv)

Structure: Comma-separated values with headers
Encoding: UTF-8 with BOM for Excel compatibility
Data Types: All values as strings
Compatibility: Works with Excel, Google Sheets, etc.

JSON (.json)

Structure: Array of ticket objects
Data Types: Preserves original data types
Format: Pretty-printed for readability
Use Case: Programmatic processing and APIs

Best Practices

Column Selection: Limit columns to reduce file size
Department Filtering: Use department filter for targeted exports
Format Choice: Choose format based on use case (Excel for analysis, CSV for data transfer, JSON for development)
Error Handling: Handle export failures gracefully
File Naming: Use descriptive filenames with timestamps

Performance Considerations

Data Volume: Large exports may take significant time
Memory Usage: Server memory usage scales with data size
Network: File download time depends on file size
Timeouts: Very large exports may hit timeout limits

Use /hubspot/tickets/list to preview data before export
Use /hubspot/tickets/list/filters to understand available data
Use /hubspot/ticket-details/{ticketId} for detailed ticket information

Notes

Export includes all tickets matching department filter
File is generated dynamically on request
Export processing time depends on data volume
Files are not stored permanently on server
Maximum export size may be limited by server configuration

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

format

enum<string>

required

Output file format. Must be one of: - xlsx for Excel - csv for CSV - json for JSON

Available options:

xlsx,

csv,

json

Example:

"xlsx"

columns

string[]

required

List of ticket fields to include in the export.

Example:

[
  "ticketId",
  "subject",
  "feedbackCategory",
  "agentInvolved",
  "createdAt"
]

departmentCode

string

Optional department code to filter exported tickets. Must be a valid department code.

Example:

"OPS"

Response

Successfully generated export file

Downloadable export file (Excel, CSV, or JSON)

Get Ticket Details Incidents Trend

​Request

​Headers

​Request Body

​Request Body Schema

​Field Details

​Response

​200 OK - Successfully generated export file

​400 Bad Request

​401 Unauthorized

​500 Internal Server Error

​Examples

​Export to Excel with all columns

​Export to CSV with specific columns

​Export to JSON format

​Implementation Examples

​React Export Component

​Vue.js Export Function

​File Format Details

​Excel (.xlsx)

​CSV (.csv)

​JSON (.json)

​Best Practices

​Performance Considerations

​Related Endpoints

​Notes

Authorizations

Body

Response

Request

Headers

Request Body

Request Body Schema

Field Details

Response

200 OK - Successfully generated export file

400 Bad Request

401 Unauthorized

500 Internal Server Error

Examples

Export to Excel with all columns

Export to CSV with specific columns

Export to JSON format

Implementation Examples

React Export Component

Vue.js Export Function

File Format Details

Excel (.xlsx)

CSV (.csv)

JSON (.json)

Best Practices

Performance Considerations

Related Endpoints

Notes