Export tickets (CSV, Excel, EML)

post

https://api.armin.cx/public/tickets/export

Export selected tickets in various formats with optional message history.

Format-Specific Behaviors:

CSV: Exports tickets as tickets.csv. When includeMessages: true, returns a ZIP file containing both tickets.csv and messages.csv.
Excel: Exports tickets as an Excel workbook (.xlsx). When includeMessages: true, creates separate sheets for tickets and messages.
EML: Exports email tickets as individual .eml files in a ZIP archive. Note: Only email channel tickets can be exported as EML. Non-email tickets will be listed in SKIPPED.txt within the ZIP.

Limitations:

Maximum 500 tickets per export request
Large exports may take several seconds to process
Ticket data is scoped to your organization

Timezone Support:
All date/time fields will be formatted according to the specified timezone (default: UTC).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

format

string

enum

required

Export format:

csv: Comma-separated values file
excel: Excel workbook (.xlsx)
eml: Email format (only for email channel tickets)

Allowed:

ticketIds

array of uuids

required

length between 1 and 500

Array of ticket IDs to export. Maximum 500 tickets per request.

ticketIds*

timezone

string

Defaults to UTC

IANA timezone identifier for formatting date/time fields. Examples: UTC, America/New_York, Europe/London, Asia/Tokyo. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for full list.

order

string

enum

Defaults to asc

Sort order for messages (chronological order by creation date):

asc: Oldest first
desc: Newest first

Allowed:

columns

array of strings

Optional list of columns to include in the export. If not specified, default columns will be used.

Default columns (included when not specified):

ticket_number - Ticket number
subject - Ticket subject/title
contact_first_name - Contact's first name
contact_last_name - Contact's last name
status - Ticket status (open, need_more_info, resolved, closed)
assigned_agent_name - Name of assigned agent
created_at - Ticket creation timestamp
updated_at - Last update timestamp

Additional available columns:

priority - Priority level (none, low, medium, high, urgent)
channel - Communication channel (email, whatsapp, voice, widget, etc.)
tags - Comma-separated list of tags
last_message_at - Timestamp of last message
message_count - Total number of messages
contact_email - Contact's email address
contact_phone - Contact's phone number
ticket_url - Direct URL to ticket in Armin CX

columns

includeMessages

boolean

Defaults to false

Whether to include message history in the export:

true: For CSV/Excel, creates a ZIP with separate files for tickets and messages
false: Exports only ticket data
Note: EML format always includes messages (this option is ignored for EML)

messageOptions

object

Options for message export (only applicable when includeMessages: true)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid API key

413Payload too large - Too many tickets

429Too many requests - Rate limit exceeded

500Internal server error