API Reference

Documentation API Reference Conversations API

Browse

Message templatesPOSTCreate a new message template.GETFind all message templates.GETList all message template tags.GETFind a message template.PUTUpdate a message template.DELDelete a message template

SessionPOSTCreate a new session GETGet all sessions PUTUpdate a session GETGet a session DELDelete a session PUTResubscribe a session GETSearch for sessions

21 more in Session

GETExport sessions POSTPre-warm sessions cache for the active project GETGet a session by user id GETGet session activities GETGet session events POSTImport sessions POSTImport sessions from intercom POSTImport sessions from HubSpot POSTImport sessions from Zendesk POSTImport sessions from Freshdesk POSTUnsubscribe sessions GETGet session checklists POSTReset session checklist GETGet session identity history GETGet session Stripe info GETGet session Chargebee info GETGet session LemonSqueezy info GETGet session Shopify info GETGet session shop info GETGet session Shopify store panel GETFindSessionShopifyInfo

TeamPOSTCreate a new team GETGet all teams GETGet the boards' team setup POSTSet the boards' team setup PUTUpdate a team DELDelete a team PUTReorder a team

MessagesPOSTCreate a new message GETFind messages by query GETSearch messages PUTUpdate a message DELDelete a message POSTCreate a thread reply GETGet thread messages

2 more in Messages

PUTSet a message reaction POSTAccept or decline an AI FAQ suggestion

Help center collectionsPOSTCreate a new collection GETGet all collections GETGet all collections with subcollections GETGet article stats PUTReorder collections GETGet a collection PUTUpdate a collection

2 more in Help center collections

DELDelete a collection PUTPublish or unpublish a collection's articles

Help center articlesPOSTCreate a new article GETGet all articles PUTReorder articles GETGet an article PUTUpdate an article DELDelete an article GETList article versions

8 more in Help center articles

POSTCreate an article version checkpoint GETGet an article version POSTRestore an article version PUTMove an article GETGet an article draft PUTSave an article draft DELDiscard an article draft POSTPublish an article draft

Help centerGETSearch help center articles GETGet help center sources GETAnswer help center question

Help center redirectsPOSTCreate a new redirect.GETFind all redirects.PUTUpdate a redirect.DELDelete a redirect

TicketPOSTCreate a new ticket GETGet all tickets POSTCreate a new ticket with an optional initial message GETSearch for tickets GETExtended ticket search (contacts + tickets)GETFind tickets by session query GETExport tickets as JSON

40 more in Ticket

GETGet notification ticket GETExport tickets as CSV GETList available export fields POSTCreate a tracker ticket GETFind tracker tickets GETSearch feature requests semantically GETGet a feature request's roadmap summary POSTGenerate tracker ticket data with AI GETGet ticket counts per status GETExport a single ticket for audit GETGet a ticket PUTUpdate a ticket DELDelete a ticket PUTMerge multiple tickets into one PUTBulk-update tickets POSTBulk-reply to tickets GETGet console logs for a ticket GETGet activity logs for a ticket GETGet the internal history of a ticket GETGet network logs for a ticket GETGet the session replay for a ticket POSTIndicate user typing POSTIndicate user viewing GETList current ticket viewers PUTSnooze a ticket PUTSet the composer draft message DELClear the composer draft message PUTLink a ticket to another ticket PUTUnlink a ticket PUTArchive a ticket PUTMark a ticket as spam PUTClose a ticket as spam (agent verdict)PUTArchive all tickets in a lane PUTUnarchive a ticket PUTAwait customer reply on a ticket POSTRun workflow POSTSend ticket to integration POSTVote for ticket POSTVoice reply (dictate or smart)POSTSend ticket conversation transcript to multiple emails

Engagement BannerPOSTCreate a new banner GETGet all banners PUTUpdate a banner DELDelete a banner GETGet a banner

Engagement Chat MessagePOSTCreate a new chat message GETGet all chat messages PUTUpdate a chat message DELDelete a chat message GETGet a chat message

Engagement CobrowsePOSTCreate a new cobrowse product tour GETGet all cobrowse product tours PUTUpdate a cobrowse product tour DELDelete a cobrowse product tour GETGet a cobrowse product tour

Engagement EmailPOSTCreate a new email GETGet all emails PUTUpdate an email DELDelete an email GETGet an email POSTRender an email preview POSTRender the email editor canvas

5 more in Engagement Email

POSTSend email preview POSTPreview Kai-written emails GETList Kai-written emails for review POSTApprove or reject Kai-written emails in bulk POSTReview a Kai-written email

Engagement NewsPOSTCreate a new engagement news article GETGet all engagement news articles GETGet an engagement news article PUTUpdate a news article.DELDelete a news article.

Engagement Product TourPOSTCreate a new product tour GETGet all product tours PUTUpdate a product tour DELDelete a product tour GETGet a product tour

Engagement Push NotificationPOSTCreate a new push notification GETGet all push notifications PUTUpdate a push notification DELDelete a push notification GETGet a push notification

Engagement SurveyPOSTCreate a new survey GETGet all surveys PUTUpdate a survey DELDelete a survey GETGet a survey GETPreview a survey deletion GETSearch survey responses

29 more in Engagement Survey

GETGet all survey responses GETExport survey responses PUTMark all survey responses as read GETGet survey response samples GETSummarize survey responses POSTValidate a survey definition POSTValidate a survey definition PUTSave a survey draft POSTEdit a survey draft with Kai POSTPublish a survey GETList survey versions GETGet a survey version PUTSave survey page settings POSTCreate personal survey links GETGet survey stats GETGet survey respondent paths GETGet survey analytics GETGet survey insights POSTLink an item to a survey theme DELUnlink an item from a survey theme POSTRefresh survey insights POSTAsk about survey results PUTEdit survey themes GETGet a survey response DELDelete a survey response POSTReach out to a respondent POSTMigrate a legacy survey GETSurvey email recipients GETSurvey email campaigns

Engagement TooltipPOSTCreate a new tooltip GETGet all tooltips PUTUpdate a tooltip DELDelete a tooltip GETGet a tooltip

Engagement Whatsapp MessagesPOSTCreate a new whatsapp message GETGet all WhatsApp messages PUTUpdate a whatsapp message DELDelete a whatsapp message GETGet a whatsapp message POSTSend a whatsapp template message

Engagement ChecklistPOSTCreate a new checklist GETGet all checklists PUTUpdate a checklist DELDelete a checklist GETGet a checklist

EngagementGETGet engagement activities GETGet engagement activities count GETFind engagement recipients GETExport engagement recipients GETGet engagement statistics POSTGet engagement fixed audience samples POSTClone engagement

AI contentPOSTCreate AI content GETGet AI content by contentId PUTUpdate AI content by contentId DELDelete AI content by contentId DELDelete old AI content batches DELDelete AI content by batchId POSTImport YouTube video

6 more in AI content

GETList YouTube content POSTPreview YouTube URL GETYouTube allowance POSTImport YouTube playlist/channel DELDelete YouTube video content DELDelete YouTube batch content

Engagement ModalPOSTCreate a new modal GETGet all modals PUTUpdate a modal DELDelete a modal GETGet a modal

InvitationGETGet all invitations for a user DELDelete an invitation PUTAccept or decline an invitation PUTUpdate an invitation's role GETGet all invitations for an organisation POSTInvite people to an organisation GETGet all invitations for a project

2 more in Invitation

POSTInvite people to a project PUTUpdate an invitation's board-only access

ProjectGETGet all users for a project PUTUpdate a project member's role DELRemove a member from a project PUTSet a member's board-only access

UserGETGet current user.POSTHand over the user's open tickets to their team GETGet unified inbox tickets GETGet unified inbox ticket PUTUpdate the current user GETGet current user's role permissions.POSTSign up a new user

4 more in User

POSTVerify a user's email address POSTResend a verification code to the user's email.POSTAuthenticate a session for websockets POSTAuthorize a session channel subscription

StatisticsGETGetReportScope GETGetChartData GETGetFactData GETGetListData GETExportListData GETGetHeatmapData GETGetEmailOverviewStats

3 more in Statistics

GETGetEmailClientUsageStats GETGetEmailClientBouncesStats GETGetRawStatistics

KnowledgePOSTSearch knowledge documents POSTFind similar tickets GETGet content tags in use

TranslationsGETList all translatable entries GETGet a single translatable entry PUTUpdate a translatable entry

AiModelsGETGet AI model catalog

CodePOSTAsk a question about the project's connected source repositories

ContactMemoryGETList contact memory entries POSTCreate or update a contact memory entry DELClear all contact memory entries GETGet one contact memory entry PUTUpdate a contact memory entry DELDelete a contact memory entry

Engagement EditorPOSTCheck whether the visual editor will work on a URL

FrontendToolsPOSTDeliver a frontend tool execution result.

CompanyGETList companies GETCount companies GETSearch companies POSTImport companies GETGet a company PUTCreate or update a company DELDelete a company

4 more in Company

GETGet company members POSTAdd a company member GETGet company conversations DELRemove a company member

UploadsPOSTUpload a file POSTImport an image from a URL POSTCreate an image upload link

PipelinesGETList pipelines GETGet a pipeline GETList pipeline fields GETList entries of a stage POSTAdd a record to a pipeline

Pipeline entriesPUTMove an entry PUTUpdate entry values PUTUpdate record values through an entry PUTSet an entry's due date DELRemove an entry GETGet an entry

AgentEvalsPOSTCreateExample

RecordsGETConversation counts for a record GETWhat is coming up on a record GETConversations waiting on us GETRecord summary POSTRefresh a record summary

S2S ContactsPUTUpsert contact GETGet contact DELDelete contact POSTTrack contact events POSTCreate conversation GETList contact conversations

S2S ConversationsGETGet conversation PATCHUpdate conversation POSTClose conversation POSTReopen conversation POSTMark conversation read POSTTyping indicator PUTSet network logs

7 more in S2S Conversations

PUTSet conversation events POSTRate conversation POSTSend message GETList messages GETGet pending workflow step POSTAnswer workflow step POSTRun workflow

S2S MessagesGETGet message POSTRate message

S2S StreamGETGet stream config POSTAuthorize channel subscription POSTAuthenticate stream user

S2S WebhooksGETList webhooks POSTCreate webhook DELDelete webhook

S2S WorkflowsGETList workflows

Ticket typesGETList boards POSTCreate a board PUTReorder boards PUTUpdate a board DELDelete a board

SettingsGETList settings pages GETGet settings PUTUpdate settings

AI provenancePOSTWas this written by Gleap's AI?

OnboardingPOSTClaim GETStatus

Collections

Documentation

Get Started

Introduction

SDKs

JavaScript

Introduction Code snippet User identity Callbacks AI chatbar Frontend tools Replays Forms Feedback button Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Environment data Track pages Track events Tags Custom URL handler Network logs Dark mode Translations Widget control Prefill the widget form Privacy controls Cookies Environment Content Security Policy (CSP)Rendering issues

Widget apps

Conversations Feature requests Help center Release notes & news Surveys Checklists Product tours

UI components

Checklist UI component AI Agent UI component

iOS

Introducing User identity Callbacks Frontend tools Forms Feedback button Activation methods Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Attachments Environment data Track events Track pages Tags Custom URL handler Network logs Dark mode Translations Widget control Prefill the widget form

Widget apps

Conversations Feature requests Help center Release notes & news Surveys Checklists

Android

Introducing User identity Callbacks Frontend tools Forms Feedback button Activation methods Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Attachments Environment data Track events Track pages Tags Custom URL handler Network logs Dark mode Translations Widget control Prefill the widget form Troubleshooting

Widget apps

Conversations Feature requests Help center Release notes & news Surveys Checklists

React Native

Introducing User identity Track events Track pages Frontend tools Forms Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Attachments Environment data Callbacks Tags Feedback button Activation methods Network logs Dark mode Translations Widget control Prefill the widget form Conversations Feature requests Help center Release notes & news Surveys Checklists React Native Expo Guide

Flutter

Introducing User identity Track events Track pages Frontend tools Forms Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Attachments Environment data Callbacks Tags Feedback button Activation methods Network logs Dark mode Translations Widget control Prefill the widget form Conversations Feature requests Help center Release notes & news Surveys Checklists

FlutterFlow

Introducing

Ionic / Capacitor

Introducing User identity Frontend tools Track events Track pages Forms Push notifications In-app notifications Audio recording Screenshots and recordings Console logs Custom actions Ticket attributes Custom data Environment data Callbacks Tags Feedback button Network logs Dark mode Translations Widget control Prefill the widget form Suppressing personal data Content Security Policy (CSP)Rendering issues Conversations Feature requests Help center Release notes & news Surveys Checklists

Cordova

Introducing User identity Track events Track pages Forms Audio recording Console logs Custom data Tags Feedback button Network logs Translations Widget control Prefill the widget form Conversations Feature requests Help center Release notes & news Surveys Checklists In-app notifications

Windows Desktop (Beta)

Introducing (Beta)User identity Track events Track pages Forms Frontend tools Console logs Custom actions Ticket attributes Custom data Callbacks Tags Feedback button Network logs Translations Widget control Prefill the widget form Attachments Conversations Feature requests Help center Release notes & news Surveys Checklists

.NET MAUI (Beta)

Introducing (Beta)User identity Track events Track pages Forms Frontend tools Console logs Custom actions Ticket attributes Custom data Callbacks Tags Feedback button Network logs Translations Widget control Prefill the widget form Attachments Conversations Feature requests Help center Release notes & news Surveys Checklists

Unity (Beta)

Introducing (Beta)User identity Track events Track pages Forms Frontend tools Console logs Custom actions Ticket attributes Custom data Callbacks Tags Feedback button Network logs Translations Widget control Prefill the widget form Attachments Conversations Feature requests Help center Release notes & news Surveys Checklists

Kai Code

Kai Code Getting started Sessions Tickets and pull requests Claude Code, Codex and others Repositories Lovable, Replit, v0 and Base44 MCP servers Customer replies Kai Code Bridge Local models

Surveys

Overview Survey definition Analytics REST API Webhooks Automations MCP tools

Sequences

MCP tools

Server-side event tracking

NodeJS REST

Guides

Enforce identity verification Authenticated conversation files Data regions Connect the Gleap MCP Plans and AI pricing Screenshots, recordings and logs Your shop API

Conversations API

API Reference

2 articles

More in API Reference

Getting Started2 articles

Privacy policy DocsPowered by Gleap