Skip to content
FlowDesk Documentation
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting started
What FlowDesk is
Quick start
Installation
Configuration
E-mail settings
Installing with Helm
Knowledge Base
LiveChat
Requirements
Integration
Authentication
Creating requests
LiveChat widget
Tracking requests
Webhooks and automation
API Reference
Overview
Attachment
/v1/attachments
/v1/attachments/{id}
/v1/attachments/configuration
/v1/attachments/{objectKey}
Uploads one file, to be referenced by a later message on one of your tickets.
InboundEmail
/v1/integration/inbound-email/webhook
Ticket
Lists tickets across the token's permitted pools (its set, or every pool for an all-pools token), paged and filtered.
Creates a ticket asynchronously. THIS IS THE RECOMMENDED WAY to open a ticket.
Gets a single ticket by id, scoped to the token's permitted pools.
Resolves the tracking key returned by the async create endpoint.
Creates a ticket synchronously. NOT RECOMMENDED.
TicketMessage
Returns the ticket's conversation — yours and ours — merged across its parent chain.
Appends a message to an existing ticket's conversation.
Same, addressed by tracking key.
Appends a message, addressing the ticket by the tracking key the create endpoint returned.
TicketForm
/v1/external/ticket-forms/{token}
/v1/external/ticket-forms/{token}
TicketTracking
/v1/external/ticket-tracking/{trackingKey}
Release Notes
Release Notes
API
Dashboard
Knowledge Base
LiveChat
Tracker
Select theme
Dark
Light
Auto
Overview
FlowDesk.API | v1
1.0.0
Section titled “FlowDesk.API | v1 1.0.0”
Information
OpenAPI version:
3.0.4
Operations
Section titled “Operations”
POST
/v1/attachments
DELETE
/v1/attachments/{id}
GET
/v1/attachments/configuration
GET
/v1/attachments/{objectKey}
POST
/v1/integration/attachments
POST
/v1/integration/inbound-email/webhook
GET
/v1/integration/tickets
POST
/v1/integration/tickets
GET
/v1/integration/tickets/{id}
GET
/v1/integration/tickets/by-tracking-key/{trackingKey}
POST
/v1/integration/tickets/sync
GET
/v1/integration/tickets/{id}/messages
POST
/v1/integration/tickets/{id}/messages
GET
/v1/integration/tickets/by-tracking-key/{trackingKey}/messages
POST
/v1/integration/tickets/by-tracking-key/{trackingKey}/messages
GET
/v1/external/ticket-forms/{token}
POST
/v1/external/ticket-forms/{token}
GET
/v1/external/ticket-tracking/{trackingKey}
Authentication
Section titled “Authentication”
Bearer
Section titled “Bearer”
Security scheme type:
http
Bearer format:
JWT