Skip to content
Changelog

Report a bug

Gleap integration: operations for AI agents

Gleap connects to Type.com as an integration. This page lists the 343 operations documented for Claude and Codex in Type.com: 152 read, 96 write, 95 destructive.

About Gleap

Gleap is an all-in-one customer feedback tool for apps and websites, enabling direct communication with users to build better software by discovering their everyday pain points.

Categories: Customer Support

How to connect Gleap to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

343 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

343 operations listed.

Message templates

  • Read

    Find all message templates.

    Find the message templates of a project that are visible to the calling agent (public templates plus templates shared with them), ordered by lexorank.

  • Read

    List all message template tags.

    List the distinct tags used across the project's message templates, sorted alphabetically.

  • Read

    Find a message template.

    Find a single message template of a project by its ID.

  • Write

    Create a new message template.

    Create a new message template. Callers who may only manage their own macros always create a private macro visible to themselves alone.

  • Destructive

    Delete a message template

    Delete a message template. Callers who may only manage their own macros can delete their personal macros only.

Team

  • Read

    Get all teams

    Get all teams associated with a project.

  • Write

    Create a new team

    Create a new team and associate it with a project.

  • Destructive

    Update a team

    Update a team.

  • Destructive

    Delete a team

    Delete a team.

  • Destructive

    Reorder a team

    Update a team's ordering position in the inbox sidebar.

Session

  • Read

    Get all sessions

    List sessions (contacts) of the project. Paginated: limit defaults to 50 and is capped at 100 per page, and paging cannot go past the first 10,000 results.

  • Read

    Get a session

    Get a session by id.

  • Read

    Search for sessions

    Autocomplete search over the project's sessions. Returns at most 50 matches, each containing only id, email, userId, name, companyId, companyName and phone.

  • Read

    Export sessions

    Export the project's contacts as a CSV file download (Content-Type: text/csv, filename users.csv). Not filterable; query parameters are ignored.

  • Read

    Get a session by user id

    Get a session by the contact's external user id (Session.userId, the id your app passes to the SDK identify call), not the Mongo id. Responds 404 when no contact with that userId exists.

  • Read

    Get session activities

    Get the tickets ("activities") of a session, newest activity first. If the session has an email address, tickets from other sessions in the project sharing that email are included as well and are flagged with isFromDuplicateSession: true.

  • Read

    Get session events

    Get the streamed events of a session, newest first. Events emitted by outbounds are relabelled to " submitted". Query parameter limit: number of events to return, default 5, maximum 300.

  • Read

    Get session checklists

    Get the non-draft checklists of a session, most recently updated first. Each entry contains only completedSteps and the parent outbound's name and step titles/ids. Query parameter limit: default 3, maximum 10.

  • Read

    Get session identity history

    Get the identity-change history for a session: recorded mutations of email / name / userId on this contact record, capped at the 100 most recent entries and returned as { history: [...] }.

  • Read

    Get session Stripe info

    Get Stripe information for a session. Returns { customer, charges, subscriptions } when the Stripe integration is configured and a customer matches the session; otherwise an empty object. Cached for 5 minutes per contact.

  • Read

    Get session Chargebee info

    Get Chargebee information for a session. Returns { customer, subscriptions, invoices } when the Chargebee integration is configured and a customer matches the session; otherwise an empty object.

  • Read

    Get session LemonSqueezy info

    Get LemonSqueezy information for a session. Returns { customer, subscriptions, invoices } when the LemonSqueezy integration is configured and a customer matches the session; otherwise an empty object.

  • Read

    Get session Shopify info

    Get Shopify information for a session. Returns { customer, orders, shopDomain }; customer may be null for guest checkouts; returns an empty object when the integration is not configured or no customer matches.

  • Read

    Get session shop info

    Get "Your shop API" information for a session: the shop customer matching the contact's email and their last 5 orders, plus returns waiting for a teammate. Empty when no shop API is connected.

  • Read

    Get session Shopify store panel

    Get the Shopify store data of a session through the commerce panel (the Gleap Shopify app's connection): the signed-in storefront customer or the customer matching the contact's email, their last 5 orders with lines, totals, tracking and returns, and the order actions a teammate…

  • Read

    Find Session Shopify Info

    GET /sessions/{sessionId}/shopify

  • Write

    Create a new session

    Create a session (contact) in the project from the project header. When userId is supplied this is an upsert: an existing contact with that userId is updated and returned instead of a new one being created (one session per project + userId).

  • Write

    Pre-warm sessions cache for the active project

    Pre-warm OpenSearch shards + Redis list cache for the active project. Fire-and-forget: returns {ok:true} immediately while the warmup runs in the background.

  • Write

    Import sessions

    Bulk-import sessions (contacts). The body must be { "sessions": [...] }.

  • Write

    Import sessions from intercom

    Import sessions from intercom.

  • Write

    Import sessions from HubSpot

    Import sessions from HubSpot.

  • Write

    Import sessions from Zendesk

    Import sessions (contacts) from Zendesk.

  • Write

    Import sessions from Freshdesk

    Import sessions (contacts) from Freshdesk.

  • Write

    Unsubscribe sessions

    Unsubscribe contacts by email and/or userId. Fire-and-forget: the response is always { "success": true } and does not reflect whether the contacts were found or updated.

  • Write

    Reset session checklist

    Reset a checklist for a session — clears all completed steps and sets it back to active.

  • Destructive

    Update a session

    Update a session (contact) in the project from the project header. The fields userId, project, organisation, gleapId and gleapHash are ignored if sent. Changing tags requires the tag permissions of the calling agent.

  • Destructive

    Delete a session

    Delete a session by id. This also permanently deletes every ticket attached to the session, a hard delete that emits no ticket events or webhooks.

  • Destructive

    Resubscribe a session

    Resubscribe a session.

Messages

  • Read

    Find messages by query

    Get messages by query with support for filtering and pagination. Filtering: - Filter by ticket: ticket=507f1f77bcf86cd799439011.

  • Read

    Search messages

    Search messages by query.

  • Read

    Get thread messages

    Get the replies of a thread as a cursor-paged envelope { items, hasMore, nextBefore }, paged like GET /messages with paginated=true: the first page holds the newest limit replies (default 50, max 100), each page is oldest-first, and before= fetches the next older page until hasM…

  • Write

    Create a new message

    Create a new message in a ticket. Required field: ticket (ticket ID).

  • Write

    Create a thread reply

    Reply inside a message's thread. Thread replies are INTERNAL — they never reach the customer, never fire webhooks/integrations/SLA, and never move the ticket's latest message.

  • Write

    Accept or decline an AI FAQ suggestion

    Resolves an AI-generated FAQ suggestion message. With accept: true the suggested question/answer pair is added to the knowledge base; with accept: false it is discarded. Either way the suggestion message is deleted.

  • Destructive

    Update a message

    Edit an existing message. Only data (the message content, e.g. data.content as TipTap JSON) and attachments are persisted; all other schema properties are ignored, and data is replaced wholesale (an omitted data clears the content).

  • Destructive

    Delete a message

    Permanently deletes a message from a ticket, together with its thread replies; this cannot be undone. No webhook or event is sent, and the ticket's updatedAt does not change.

  • Destructive

    Set a message reaction

    Add or remove an emoji reaction on a message. Reactions are INTERNAL — never visible to end customers, never fire webhooks/SLA/unread, never move the ticket's latest message. The update reaches open dashboards via the ordinary comment.updated broadcast.

Help center

  • Read

    Search help center articles

    Full-text search the published articles of a help center. Returns at most 30 hits, filtered to the requested language and to the articles the current visitor session is allowed to see.

  • Read

    Get help center sources

    Find the help center sources (articles and indexed URLs) most relevant to a search term, as used for AI answers. searchTerm is required (the request fails without it). Each source is returned with id, title, url and a short extract.

  • Read

    Answer help center question

    Answer a visitor question with AI, grounded in the project's help center content. Pass the question in the question query parameter (required) and optionally lang. Returns the generated answer under answer. Same authentication headers as the search endpoint.

Help center collections

  • Read

    Get all collections with subcollections

    Get all help center collections (subcollections included)

  • Read

    Get article stats

    Get live/draft article counts across the whole help center

  • Read

    Get a collection

    Get a help center collection by id

  • Write

    Create a new collection

    Create a new help center collection. project, docId and lexorank are assigned by the server and ignored if sent. When parent is set, baseAudienceFilter is inherited from the parent collection (any value sent is overwritten) and an unknown parent returns 404.

  • Destructive

    Reorder collections

    Set the order of the collections on one level of the tree. Send every collection id in the order they should appear, plus the parentId whose children are being ordered (omit it for the top level).

  • Destructive

    Update a collection

    Update a help center collection. Changing targetAudience, baseAudienceFilter or extendedAudienceFilter also re-applies the resulting audience filter to every article in this collection and, recursively, to all subcollections and their articles.

  • Destructive

    Delete a collection

    Delete a help center collection. The collection must be empty: the request is rejected with 409 while it still contains articles. Subcollections are not deleted; move or delete them first. Returns { success: true }.

  • Destructive

    Publish or unpublish a collection's articles

    Publish or unpublish every article in a help center collection. Set unpublished to true to unpublish or false to publish; the change is applied recursively to all articles in this collection and in all of its subcollections. The collection document itself is not modified.

Help center articles

  • Read

    Get all articles

    Get every article in a help center collection, published and unpublished, sorted by lexorank. This endpoint is not paginated.

  • Read

    Get an article

    Get a help center article by id. Pass format=html or format=markdown to additionally include the article content converted to that format (as a localized contentHtml / contentMarkdown field) next to the stored editor JSON. Omit the parameter to return the article unchanged.

  • Read

    List article versions

    List the retained version snapshots of a help center article (newest first)

  • Read

    Get an article version

    Get a single version snapshot of a help center article, including its content

  • Read

    Get an article draft

    Get the staged (unpublished) draft of a help center article, or null

  • Write

    Create a new article

    Create a new help center article in a collection. title, description and content may be sent either localized ({ "en": ... }) or as a bare value, which is stored under the help center's default language.

  • Write

    Create an article version checkpoint

    Capture a manual version checkpoint of the article's current state

  • Write

    Restore an article version

    Restore a help center article to a previous version (the current state is snapshotted first, so the restore itself can be undone)

  • Write

    Publish an article draft

    Publish a staged draft to the live article (promote). Pass force=true to override the warning when the live article changed since the draft started.

  • Destructive

    Reorder articles

    Set the order of the articles in a collection. Send every article id in the order they should appear; the server rewrites all of the collection's ranks so the order is exact and stable. Articles left out of the list keep their relative order and follow the listed ones.

  • Destructive

    Update an article

    Update a help center article. content is TipTap JSON; images are image nodes referencing a hosted image URL ({ "type": "image", "attrs": { "src": " " } }) — upload files via POST /v3/uploads first and use the returned fileUrl as the src.

  • Destructive

    Delete an article

    Delete a help center article

  • Destructive

    Move an article

    Move a help center article to a different collection

  • Destructive

    Save an article draft

    Create or update the staged draft of an article. The live article is never modified by this call; use the draft publish endpoint to promote it.

  • Destructive

    Discard an article draft

    Discard the staged draft of an article (the live article is untouched)

Help center redirects

  • Read

    Find all redirects.

    Find all redirects of a project.

  • Write

    Create a new redirect.

    Create a new redirect.

  • Destructive

    Update a redirect.

    Update a redirect.

  • Destructive

    Delete a redirect

    Delete a redirect.

Ticket

  • Read

    Get all tickets

    Get all tickets in a project with support for filtering, sorting, and pagination. Filtering: - Filter by type: type=BUG or type=BUG,FEATUREREQUEST - Filter by status: status=OPEN - Filter by priority key: priority=HIGH or priority=HIGH,MEDIUM.

  • Read

    Search for tickets

    Full-text search over the project's tickets and their comments. Returns { hits: [...] } with at most 30 hits, ordered by relevance. Query parameters: searchTerm (required, max 100 characters), type (optional ticket type filter, e.g. BUG), status (optional status filter, e.g.

  • Read

    Extended ticket search (contacts + tickets)

    Searches contacts and tickets in parallel and returns two buckets: sessionResults (tickets belonging to matching contacts, with their latest comment) and generalResults. Each bucket is capped at 250 tickets.

  • Read

    Find tickets by session query

    Resolves contacts (sessions) matching the given identifiers (at most 100) and returns their tickets as { tickets, count, totalCount }. Archived, hidden, spam and merged-duplicate tickets are excluded and at most 500 tickets are returned.

  • Read

    Export tickets as JSON

    Returns the project's tickets as a JSON array, capped at 25,000 tickets. Supports the usual ticket filters. For larger exports or CSV output use GET /tickets/csv-export.

  • Read

    Get notification ticket

    Get notification ticket. The dashboard calls this for every websocket ticket event whose ticket isn't already loaded — it is a READ, gated on TICKETFIND like GET /tickets.

  • Read

    Export tickets as CSV

    Streams the project's tickets as a CSV download (tickets.csv, text/csv), with no row cap. For a JSON export use GET /tickets/export instead. Rows: type narrows the export to one type or a comma-separated list such as BUG,INQUIRY,BOT (BOT is the Kai conversations lane).

  • Read

    List available export fields

    Returns the exportable field definitions ({ fields: [...] }) for a ticket type; use these keys as projection[] values on GET /tickets/csv-export.

  • Read

    Find tracker tickets

    Find tracker tickets in a project.

  • Read

    Search feature requests semantically

    Dedupe-style search across the project's FEATUREREQUEST tickets. Uses OpenSearch fuzzy match + Voyage AI rerank — returns the most semantically similar matches to the query argument, not literal keyword hits. Use this before filing a new feature request to avoid duplicates.

  • Read

    Get a feature request's roadmap summary

    Roadmap summary of one feature request: title, a description excerpt, the customer-facing status, the upvote count and the public share link. ticketId is the ticket id or its number (123 or 123).

  • Read

    Get ticket counts per status

    Returns the number of tickets grouped by status, as [{ "id": "OPEN", "count": 12 }, ...]. Counts always exclude archived, hidden, spam and merged-duplicate tickets. Other filters (e.g.

  • Read

    Export a single ticket for audit

    Returns an audit-focused CSV export of one ticket: one row per event in strict chronological order with the columns timestamp, actor, actoremail, eventtype, detail, content.

  • Read

    Get a ticket

    Get a ticket in a project.

  • Read

    Get console logs for a ticket

    Get console logs for a ticket in a project.

  • Read

    Get activity logs for a ticket

    Get activity logs for a ticket in a project.

  • Read

    Get the internal history of a ticket

    Every internal history entry for a ticket — status, assignee, team, priority, type, tag, contact, due-date and title changes, plus workflow starts, agent handoffs and mirrored integration status updates.

  • Read

    Get network logs for a ticket

    Get network logs for a ticket in a project.

  • Read

    Get the session replay for a ticket

    Returns a self-contained HTML page that plays back the ticket's recorded session replay. Responds 404 when the ticket has no replay recording.

  • Read

    List current ticket viewers

    Returns the set of agents currently viewing tickets in the project (presence). Dashboards call this to seed and periodically reconcile viewer avatars, so presence does not depend on keepalive broadcasts.

  • Write

    Create a new ticket

    Create a new ticket in a project. Every field is optional. Common fields include: title, description, type (BUG, FEATUREREQUEST, etc.), status, priority, session (contact/session ID if manually added), and customData (custom fields).

  • Write

    Create a new ticket with an optional initial message

    Create a new ticket and optionally post an initial message in a single request. Provide either a session (contact ID) or email to associate the ticket with a contact. If an email is provided and no contact exists, one will be created automatically.

  • Write

    Create a tracker ticket

    Create a tracker ticket in a project. When customerEmail is set, the customer is added as the first upvoter (upvotes: [{ email, name }], upvotesCount: 1) and their session (source ticket's session, else resolved by email) becomes the ticket's creator session — used for feature r…

  • Write

    Generate tracker ticket data with AI

    Uses AI to draft a tracker ticket from an existing ticket. Returns { title, description }: a short title and a ~30-word summary written in the project's default summary language. Responds 404 when sourceTicketId does not resolve to a ticket. type (e.g.

  • Write

    Bulk-reply to tickets

    Send the same customer-visible reply to every ticket in the selection. Unlike bulk updates there is NO fast path — every reply runs the full createComment pipeline (channel/email delivery, notifications, SLA clearing, workflows, integrations).

  • Write

    Indicate user typing

    Indicate user is typing.

  • Write

    Indicate user viewing

    Indicate user is viewing.

  • Write

    Run workflow

    Run workflow

  • Write

    Send ticket to integration

    Send ticket to integration

  • Write

    Vote for ticket

    Vote for a feature request. action controls semantics: 'toggle' (default) flips the vote, 'subscribe' is idempotent add, 'unsubscribe' is idempotent remove. ticketId is the ticket id or its number; only feature requests take votes.

  • Write

    Voice reply (dictate or smart)

    Process an operator's recorded audio for a ticket with one multimodal model call. dictate returns a verbatim transcript; smart treats the audio as spoken keywords and drafts a fluent reply using the ticket + conversation as context (no knowledge-base retrieval).

  • Write

    Send ticket conversation transcript to multiple emails

    Send the conversation history of a ticket to a list of email addresses

  • Destructive

    Update a ticket

    Update a ticket in a project.

  • Destructive

    Delete a ticket

    Permanently deletes a ticket; this cannot be undone. Also deletes every ticket marked as its duplicate, along with all messages, scheduled replies, console/network logs and replay data, and removes the ticket from other tickets' linked lists.

  • Destructive

    Merge multiple tickets into one

    Merges ticketsToMergeIds into a target ticket and returns the resulting main ticket. targetTicketId is required unless shouldCreateNewTicket is true, in which case a fresh main ticket is created (and an existing target ticket, if given, is archived too).

  • Destructive

    Bulk-update tickets

    PUT /tickets/bulk

  • Destructive

    Snooze a ticket

    Snoozes a ticket for duration seconds: sets snoozedUntil, moves the status to SNOOZED and clears the unread flag. The ticket reopens automatically when the snooze expires.

  • Destructive

    Set the composer draft message

    Stage a drafted reply in the ticket's dashboard composer. content is either a Markdown string (converted server-side to the composer's rich-text format) or a TipTap doc. The draft appears instantly in the composer of everyone viewing the ticket; nothing is sent to the customer.

  • Destructive

    Clear the composer draft message

    Remove the composer draft message from a ticket. No-op when the ticket has no draft.

  • Destructive

    Link a ticket to another ticket

    Creates a bidirectional link between the ticket and targetTicketId and returns the updated list of linked tickets. Linking a regular ticket to a tracker ticket also archives the regular ticket (it is now tracked by the tracker).

  • Destructive

    Unlink a ticket

    Unlink a ticket in a project.

  • Destructive

    Archive a ticket

    Archive a ticket in a project.

  • Destructive

    Mark a ticket as spam

    Mark a ticket as spam: flags the ticket (and its merged duplicates) as spam, archives it into the spam tab, and blocks the contact — future tickets from them are auto-flagged as spam and inbound emails from them are dropped unless whitelisted.

  • Destructive

    Close a ticket as spam (agent verdict)

    CLOSE a ticket as spam (agent/MCP verdict): sets the done status, flags + archives it into the Spam review queue, and suppresses every customer-facing follow-up — no CSAT, no notifications, no knowledge extraction.

  • Destructive

    Archive all tickets in a lane

    Archives every non-archived ticket of the given type and status (both required in the body). Pass the board's active filter (the same JSON string GET /tickets takes) to archive only the filtered subset — omit it to archive the whole lane.

  • Destructive

    Unarchive a ticket

    Unarchive a ticket in a project.

  • Destructive

    Await customer reply on a ticket

    Park a ticket as "waiting on customer": set expectsReply and archive it. The customer's next reply automatically un-archives, clears the flag, and resumes any awaiting agent.

Engagement Banner

  • Read

    Get all banners

    Get the engagement banners of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a banner

    Get an engagement banner

  • Write

    Create a new banner

    Create a new engagement banner. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a banner

    Update an engagement banner. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a banner

    Delete an engagement banner

Engagement Chat Message

  • Read

    Get all chat messages

    Get the engagement chat messages of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a chat message

    Get an engagement chat message

  • Write

    Create a new chat message

    Create a new engagement chat message. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a chat message

    Update an engagement chat message. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a chat message

    Delete an engagement chat message

Engagement Cobrowse

  • Read

    Get all cobrowse product tours

    Get the engagement cobrowse product tours of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a cobrowse product tour

    Get an engagement cobrowse product tour

  • Write

    Create a new cobrowse product tour

    Create a new engagement cobrowse product tour. type, project, organisation and createdBy are set server-side and ignored if supplied. config.type is set server-side as well.

  • Destructive

    Update a cobrowse product tour

    Update an engagement cobrowse product tour. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a cobrowse product tour

    Delete an engagement cobrowse product tour

Engagement Email

  • Read

    Get all emails

    Get the engagement emails of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get an email

    Get an engagement email

  • Read

    Preview Kai-written emails

    Writes Kai emails for a few sample recipients with the saved Kai config. Nothing is sent or stored; the model calls are billed as AI usage.

  • Read

    List Kai-written emails for review

    The Kai-written emails of this email, newest first, 25 per page, with per-status counts.

  • Write

    Create a new email

    Create a new engagement email. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Write

    Render an email preview

    Render an email the way a recipient gets it, from unsaved editor values: emailStyle (plain, personal or company), subject, preheader, message (TipTap JSON, or { localized: { : doc } }), optional sender (a teammate id, or { customSenderName }), lang and brand (unsaved emailBrand…

  • Write

    Render the email editor canvas

    The editor canvas of an email: the email of the look (emailStyle) rendered around an empty body, with slot marking where the body goes, and css that styles the editor's content (TipTap markup under the root selector) like the renderer styles the body.

  • Write

    Send email preview

    Send a test email of an engagement email to up to 10 addresses. Fails with 400 and the reason when the email can't be sent (invalid address, email limit, invalid sender, …).

  • Write

    Approve or reject Kai-written emails in bulk

    Approve or reject several Kai-written emails that wait for review. Edits are not possible here.

  • Write

    Review a Kai-written email

    Approve (optionally with an edited subject and body) or reject one Kai-written email that waits for review. An approved email is sent at its send time through the email's look.

  • Destructive

    Update an email

    Update an engagement email. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete an email

    Permanently delete an engagement email, including its delivery records. This cannot be undone.

Engagement News

  • Read

    Get all engagement news articles

    Get the engagement news articles of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get an engagement news article

    Get a news article by id.

  • Write

    Create a new engagement news article

    Create a news article for a project. subject is required, either as { localized: { en: "..." } } or as a bare per-language map { en: "..." } (canonicalized server-side; same for message and markdownMessage).

  • Destructive

    Update a news article.

    Update an engagement news article. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a news article.

    Delete an engagement news article

Engagement Product Tour

  • Read

    Get all product tours

    Get the engagement product tours of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a product tour

    Get an engagement product tour

  • Write

    Create a new product tour

    Create a new engagement product tour. type, project, organisation and createdBy are set server-side and ignored if supplied. config.type is set server-side as well.

  • Destructive

    Update a product tour

    Update an engagement product tour. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a product tour

    Delete an engagement product tour

Engagement Push Notification

  • Read

    Get all push notifications

    Get the engagement push notifications of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a push notification

    Get an engagement push notification

  • Write

    Create a new push notification

    Create a new engagement push notification. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a push notification

    Update an engagement push notification. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a push notification

    Delete an engagement push notification

Engagement Survey

  • Read

    Get all surveys

    Get the engagement surveys of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a survey

    Get an engagement survey

  • Read

    Preview a survey deletion

    What deleting the survey affects besides its own data, for the confirmation: the live email campaigns that send it (paused on delete, their pending sends dropped) and how many survey tickets from before Surveys 2.0 are deleted with it.

  • Read

    Search survey responses

    Full-text search over the answers of all the project's survey responses (Surveys 2.0), newest first.

  • Read

    Get all survey responses

    Get the responses of a survey, unread first, then newest first. Supports skip, limit (defaults to 1000 when omitted; supplied values above 100 are clamped to 100) and field filters via query parameters.

  • Read

    Export survey responses

    Export all responses of a survey as a downloadable file. CSV by default (Content-Type: text/csv, sent as an attachment named after the survey).

  • Read

    Get survey response samples

    Get a random sample of up to 10,000 responses for a survey, for client-side aggregation. Returns { samples, sampleSize, count } where count is the total number of matching responses and sampleSize is the 10,000 sampling ceiling.

  • Read

    Summarize survey responses

    AI summary of a survey's responses. Returns status ok with summary (plain text) and data (headline, overview, sentiment, findings with verbatim quotes that carry the response ticketId, themes, actions), not-enough-data below 3 responses, rate-limited within 60 seconds of the las…

  • Read

    Validate a survey definition

    Validate a Surveys 2.0 definition without saving it (editor, MCP validatesurvey). Body { definition }. Returns { ok, errors: [{ path, code, message }] }.

  • Read

    Validate a survey definition

    Validate a Surveys 2.0 definition for this survey. Body { definition }. Returns { ok, errors }.

  • Read

    List survey versions

    The published versions of a survey, newest first: [{ version, createdAt, createdBy }].

  • Read

    Get a survey version

    One published version with its definition: { version, definition, createdAt, createdBy }.

  • Read

    Get survey stats

    Survey results from the daily counters. Query from, to (YYYY-MM-DD) and version. Returns { version, totals: { shown, started, completed, partial, avgDurationMs }, nps?, perBlock, edges, endings, channels, themes, daily }.

  • Read

    Get survey respondent paths

    How respondents moved through the survey, for the Results flow chart. Query from, to (YYYY-MM-DD) and version.

  • Read

    Get survey analytics

    Survey step analytics from ClickHouse (surveyevents), Typeform-style. Query from, to (YYYY-MM-DD, UTC, inclusive; default the last 30 days, at most 400), version, channel, device (phone|tablet|desktop), interval (day|week), tz (IANA zone for the weekday × hour heatmap).

  • Read

    Get survey insights

    The stored AI insights: { themes, summary, drivers, segments, alerts, updatedAt }. Never runs the model.

  • Read

    Get a survey response

    One response with its contact and the definition of the version it answered: { response, contact, definition }.

  • Read

    Survey email recipients

    Per-recipient tracking of a survey email campaign: query campaign (the EMAIL outbound id), cursor, limit (≤ 100). Returns { items: [{ contact, sentAt, opened, openedAt, answered, answeredFromEmail, responseId, responseStatus }], nextCursor? }, newest send first.

  • Read

    Survey email campaigns

    The project's email campaigns about this survey (Share → Email), newest first, at most 100, without the email bodies.

  • Write

    Create a new survey

    Create a new engagement survey. type, project, organisation and createdBy are set server-side and ignored if supplied. Surveys 2.0: with a definition (SurveyDefinition, schemaVersion 2) the survey is created as a v2 DRAFT: body { name, format?: 'card'|'full', definition, trigger?

  • Write

    Edit a survey draft with Kai

    Ask Kai to edit the draft. Body { instruction, definition?, selectedId?, lang? }: definition is the editor's working copy (default: the stored draft), selectedId the step "this question" refers to, lang the language the teammate is viewing.

  • Write

    Publish a survey

    Publish the draft as the next version. The page and emails serve it; it shows in the app only while the survey is live there ({ goLive: true } also switches that on). Returns { version, publishedAt, status }; 422 { errors } when the draft is invalid.

  • Write

    Link an item to a survey theme

    Link a bug / feature request (ticketId) or a Kai Code session (cloudSessionId, or the clientLaunchId of a Kai Code draft that is not sent yet) to an AI theme (themeId) and/or a finding of the brief (finding: its title). The ticket or session must belong to the survey's project.

  • Write

    Refresh survey insights

    Queue a rebuild of the AI insights (at most every 5 minutes). Returns { queued, retryAfterSeconds? }.

  • Write

    Ask about survey results

    Ask Kai about the results. Body { question, version? }; with version (a positive integer, the Results page's version filter) the answers, totals and theme counts are that version's only. Returns { answer (markdown), citations: [{ responseId, quote }], basedOn, version? }.

  • Write

    Reach out to a respondent

    Start a conversation with the respondent. Body { channel: 'messenger'|'email', message (TipTap JSON or markdown text), subject?, assignToMe? }. The ticket carries surveyResponse; returns { ticketId, ticketShareToken }.

  • Write

    Migrate a legacy survey

    Convert a legacy survey to Surveys 2.0 (published as version 1) and move its answer tickets into survey responses. Idempotent. Up to 1000 tickets move in the request; the rest continue in the background.

  • Destructive

    Update a survey

    Update an engagement survey. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a survey

    Permanently delete an engagement survey with everything stored for it: its versions, all of its responses (with the files respondents uploaded, and the SURVEY tickets of a survey from before Surveys 2.0), its stats and analytics, its delivery records and its search index entries.

  • Destructive

    Mark all survey responses as read

    Mark all engagement survey responses as read

  • Destructive

    Save a survey draft

    Save the Surveys 2.0 draft. Body { definition, baseRevision?, allowEmpty? }. Invalid logic is saved and returned as warnings; a malformed definition answers 422 { errors }. Live surveys keep serving the published version. Returns { definition, draftRevision, warnings }.

  • Destructive

    Save survey page settings

    Save the survey page settings (SurveyPageSettings); the slug is unique per project (409 slugtaken).

  • Destructive

    Unlink an item from a survey theme

    Remove a link between a theme / finding and a bug, feature request or Kai Code session. The item itself stays.

  • Destructive

    Edit survey themes

    Rename, add, merge or delete AI themes. Body { themes?: [{ id?, label, description?, polarity? }], merge?: [{ from, into }], delete?: [id] }. Returns { themes }.

  • Destructive

    Delete a survey response

    Delete a response (its counts are taken out of the stats).

Engagement Tooltip

  • Read

    Get all tooltips

    Get the engagement tooltips of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a tooltip

    Get an engagement tooltip

  • Write

    Create a new tooltip

    Create a new engagement tooltip. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a tooltip

    Update an engagement tooltip. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a tooltip

    Delete an engagement tooltip

Engagement Whatsapp Messages

  • Read

    Get all WhatsApp messages

    Get the engagement WhatsApp messages of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a whatsapp message

    Get an engagement whatsapp message

  • Write

    Create a new whatsapp message

    Create a new engagement WhatsApp message. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Write

    Send a whatsapp template message

    Send a WhatsApp template message to a phone number with optional custom variable values. The customValues keys must match the templateVariable names from your variable mapping.

  • Destructive

    Update a whatsapp message

    Update an engagement WhatsApp message. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a whatsapp message

    Permanently delete an engagement WhatsApp message, including its delivery records. This cannot be undone.

Engagement Checklist

  • Read

    Get all checklists

    Get the engagement checklists of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a checklist

    Get an engagement checklist

  • Write

    Create a new checklist

    Create a new engagement checklist. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a checklist

    Update an engagement checklist. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a checklist

    Delete an engagement checklist

Engagement

  • Read

    Get engagement activities

    Get the activities recorded for a single engagement, paginated via skip/limit.

  • Read

    Get engagement activities count

    Get the number of activities recorded for a single engagement. Returns { count }.

  • Read

    Find engagement recipients

    Get the recipients of a single engagement. Returns { data, total }.

  • Read

    Export engagement recipients

    Export the recipients of a single engagement as CSV (Content-Type: text/csv, sent as an attachment named after the engagement). Accepts the same filter query as the recipients list, so a filtered view (e.g. only recipients who opened) exports exactly what is shown.

  • Read

    Get engagement statistics

    Get delivery and response statistics for a single engagement. Responds 404 for an unknown engagement.

  • Read

    Get engagement fixed audience samples

    Estimate the fixed audience of an engagement. Send targetAudience and conditions in the body to preview a candidate audience without saving it.

  • Write

    Clone engagement

    Clone an engagement. The copy is always created as a draft named "Copy of "; name and status sent in the body are ignored. Any other body fields override the cloned values.

S2S Webhooks

  • Write

    Create webhook

    Register a webhook endpoint. The signing secret is returned exactly once.

  • Destructive

    Delete webhook

    Delete a webhook endpoint.

AI content

  • Read

    Get AI content by contentId

    Get AI content by contentId Retrieve a single AI content entry by its contentId

  • Read

    Preview YouTube URL

    Preview a YouTube URL before importing. Fetches metadata + an exact cost estimate (in cents) for the video or full playlist/channel, and on the new terms the plan's YouTube allowance and whether the import fits.

  • Read

    YouTube allowance

    The workspace's YouTube allowance (new terms): video per period, used, left, the per-video maximum and the playlist size. allowance is null on the old terms (no limits); allowed is false when the plan has no YouTube sources (Free), with the plan that has them.

  • Write

    Import YouTube video

    Import a single YouTube video for AI content analysis

  • Write

    Import YouTube playlist/channel

    Import a YouTube playlist or channel for bulk AI content analysis

  • Destructive

    Update AI content by contentId

    Update an AI content entry by its contentId. If no entry with that contentId exists, one is created (upsert).

  • Destructive

    Delete AI content by contentId

    Delete AI content by contentId Remove an AI content entry by its contentId

  • Destructive

    Delete old AI content batches

    Delete all AI content except the current batch Remove all AI content entries except those with the current batch ID, optionally filtered by type

  • Destructive

    Delete AI content by batchId

    Delete all AI content by batchId Remove all AI content entries with the specified batchId

  • Destructive

    Delete YouTube video content

    Delete a single YouTube video's content

  • Destructive

    Delete YouTube batch content

    Delete all YouTube content from a batch

Engagement Modal

  • Read

    Get all modals

    Get the engagement modals of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100.

  • Read

    Get a modal

    Get an engagement modal

  • Write

    Create a new modal

    Create a new engagement modal. type, project, organisation and createdBy are set server-side and ignored if supplied.

  • Destructive

    Update a modal

    Update an engagement modal. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document.

  • Destructive

    Delete a modal

    Delete an engagement modal

Invitation

  • Read

    Get all invitations for a user

    Get all invitations for a user.

  • Read

    Get all invitations for an organisation

    Get all invitations for an organisation.

  • Read

    Get all invitations for a project

    Get all invitations for a project. The project is taken from the required project header; requires invitation permissions on it, like inviting.

  • Write

    Invite people to an organisation

    Invite one or more people (body: { "emails": [...] }) to an organisation. Each invitation is created with the user role and an invitation email is sent.

  • Write

    Invite people to a project

    Invite one or more people (body: { "emails": [...] }) to the project given in the required project header. Each invitation is created with the user role, or AGENT when the inviter's role could not grant user, and an invitation email is sent.

  • Destructive

    Accept or decline an invitation

    Accept or decline an invitation addressed to the authenticated user. On accept the user is added to the organisation or project with the invitation's role. The invitation is consumed (deleted) either way.

  • Destructive

    Delete an invitation

    Delete an invitation. The person it was sent to can decline it this way; anyone else needs the rights to send it: organisation admin or manager for an organisation invitation, invitation permissions on the project for a project invitation.

  • Destructive

    Update an invitation's role

    Change the role an invitation will grant when accepted. Invitations are created with the user role, or AGENT when the inviter's role could not grant user, so this is the way to grant a different role before acceptance.

Project

  • Read

    Get all users for a project

    Get everyone who can access this project: direct project members plus all members of its organisation. Each entry carries type (project or organisation) and role. Service accounts are excluded.

  • Destructive

    Update a project member's role

    Change a member's role within the project given in the required project header. Only the project creator or an admin of the project/organisation may do this, and you cannot change your own role (403). Returns true.

  • Destructive

    Remove a member from a project

    Remove a member from the project given in the required project header. The user is also removed from every team in that project. The user account itself is not deleted.

User

  • Read

    Get current user.

    Get the authenticated user. Credentials and internal fields (password, code, serviceAccountApiToken, marketingTracking, WebAuthn key material) are never included in the response.

  • Read

    Get unified inbox tickets

    Get open conversations from every project the authenticated user can access. Only INQUIRY tickets are returned; done, snoozed, archived, spam, hidden and merged-duplicate tickets are excluded. Returns { tickets: [...] }.

  • Read

    Get unified inbox ticket

    Get a single unified-inbox conversation. Returns 404 if the ticket is not of type INQUIRY or the authenticated user has no INQUIRY access to its project.

  • Read

    Get current user's role permissions.

    Returns the roles and effective permissions of the authenticated user, scoped to the organisationId query parameter if given, otherwise to the organisation owning the project header, otherwise to the first organisation the user is a member of.

  • Write

    Hand over the user's open tickets to their team

    Hands over the authenticated user's open conversations to their teammates. Only OPEN tickets that are currently assigned to the user AND belong to a team are affected, at most 100 per call; teams using manual assignment are skipped. Returns { success: true }.

  • Write

    Verify a user's email address

    Confirm a new user's email address with the 6-digit code sent at signup. The code expires 10 minutes after it was issued. On success any pending invitations for that email are accepted and a JWT plus the confirmed user is returned. Rate limited to 30 requests per hour per IP.

  • Write

    Resend a verification code to the user's email.

    Resend a verification code to the user's email.

  • Write

    Authenticate a session for websockets

    Authenticate a widget session for websocket use. Authenticated with the project's public API key (api-token header) plus a signed session identity (gleap-id/gleap-hash headers), not with a dashboard JWT.

  • Write

    Authorize a session channel subscription

    Authorize a websocket subscription to the caller's own private-session- channel. Any other channel name returns { "valid": false } with HTTP 200. Authenticated with the project's public API key (api-token header) plus a signed session identity (gleap-id/gleap-hash headers).

Company

  • Read

    Count companies

    Number of companies matching the same search and conditions the list route accepts. Drives the live match count in the pipeline bulk-add filter.

  • Read

    Get a company

    Get one company by its external companyId, the identifier your app sends via the SDK, not the Gleap id.

  • Read

    Get company members

    List the contacts linked to a company, most recently active first. Paginated via skip (default 0) and limit (default 50, maximum 200). Each row contains only id, name, email, userId, avatar and lastActivity.

  • Read

    Get company conversations

    List conversations stamped with this company at creation time, newest activity first. Paginated via skip (default 0) and limit (default 25, maximum 100). Conversations a contact had before being linked to the company are not included unless they were migrated.

  • Write

    Import companies

    Create or update many companies at once, matched by companyId (the dashboard's CSV importer). Body: { companies: [{ companyId, name, plan, domain, value, sla, tags, address, customData, ownerEmail }] }, at most 1000 rows per call.

  • Write

    Add a company member

    Link a contact to this company. migrateTickets opts into re-stamping the contact's existing conversations onto this company — off by default, since the stamp records which company a past conversation was had with.

  • Destructive

    Create or update a company

    Create or update a company by its external companyId (upsert). Only name, plan, domain, value, sla, tags, address, customData and the account owner (owner or ownerEmail) are accepted; any other field is ignored.

  • Destructive

    Remove a company member

    Unlink a contact from this company. Existing conversations keep their original company stamp.

Statistics

  • Read

    Get Report Scope

    What the requesting teammate can see in Reports: how many boards are left out of their numbers (a count, never names) and which capability-gated reports they can open.

  • Read

    Get Chart Data

    Get bar chart data for various statistics

  • Read

    Get Fact Data

    Get fact data for various statistics

  • Read

    Get List Data

    Get list data for various statistics

  • Read

    Export List Data

    Export list data as CSV. Returns a UTF-8 CSV file as an attachment (Content-Disposition: attachment), not JSON.

  • Read

    Get Heatmap Data

    Get heatmap data for activity patterns

  • Read

    Get Email Overview Stats

    Get email overview statistics. Pass outboundId (query) to restrict the statistics to a single outbound campaign.

  • Read

    Get Email Client Usage Stats

    Get email client usage statistics. Pass outboundId (query) to restrict the statistics to a single outbound campaign.

  • Read

    Get Email Client Bounces Stats

    Get email client bounce statistics. Pass outboundId (query) to restrict the statistics to a single outbound campaign.

  • Read

    Get Raw Statistics

    Get raw statistics data. Filterable fields: actionType (e.g. HOMEMENUCLICK), resourceType (e.g. WIDGET), actionUser, associatedEntity, description, first, rowId, and the data. fields (data.type, data.tags, data.processingUser, data.ticketId, …).

Knowledge

  • Read

    Search knowledge documents

    Search through knowledge base documents using vector search and reranking. Returns matching documents from help-center articles, FAQs/snippets, websites, news, YouTube videos, and code knowledge.

  • Read

    Find similar tickets

    Search for similar tickets using vector similarity search. Returns tickets with a similarity score of at least 0.3.

  • Read

    Get content tags in use

    Get the distinct set of content tags actually in use across the project's knowledge content (snippets/FAQ/files/youtube answers, help-center articles, and web-crawler pages). Read-only — does not read or modify the project's tag registry.

Pipelines

  • Read

    List entries of a stage

    List the entries of one stage, ordered by their board position. laneId is the stage's id from the pipeline's lanes. Paginated via skip (default 0) and limit (default 50, maximum 200).

  • Read

    List pipelines

    List the pipelines visible to the authenticated user, most recently updated first. A pipeline is visible when it is public or explicitly shared with the user — an API service account only sees public pipelines and those it was added to.

  • Read

    Get a pipeline

    Get one pipeline by its id, including its stages (lanes) and column configuration. A pipeline holds records of exactly one type: companies or contacts (recordType).

  • Read

    List pipeline fields

    The fields of one pipeline, in column order. A field's source says where its value lives: ENTRY fields are stored on the entry — their fieldIds are the keys entry values accept — while RECORD fields read (and write through to) an attribute of the company or contact and arrive on…

  • Write

    Add a record to a pipeline

    Add a company or contact to a pipeline. recordId is the Gleap id of the record — a company's id (see GET /companies) or a contact's id, matching the pipeline's recordType.

Contact Memory

  • Read

    Get one contact memory entry

    Get the full content of a single memory entry.

  • Write

    Create or update a contact memory entry

    Create or upsert a memory entry by name. Returns { ok: true, entries: }; invalid input returns 400 and an unknown session 404. Staff writes work even when the project's contact-memory feature is disabled.

  • Destructive

    Clear all contact memory entries

    Clear all memory entries for a contact.

  • Destructive

    Update a contact memory entry

    Create or replace the memory entry with this name; the entry is upserted, so a PUT to a name that does not exist yet creates it. This is a full replace, not a patch: omitting description clears the stored description.

  • Destructive

    Delete a contact memory entry

    Delete one memory entry by name.

Translations

  • Destructive

    Update a translatable entry

    Pushes a translation for a specific entry and language. The entry ID uses the format "type:id" as returned by GET /translations/entries. The id part is a Mongo id for article, collection and emailtemplate (e.g.

Ai Models

  • Read

    Get AI model catalog

    Returns the full model catalog, the curated picker lists (Kai agent, Kai Code cloud, Kai Code OpenCode, transcription), and the per-runtime default model ids. Internal fields and markup metadata are not exposed; customer-facing cost figures are pre-computed.

Code

  • Write

    Ask a question about the project's connected source repositories

    Forwards the question to the code analyzer, which clones all repositories connected to this project, investigates them, and returns a user-facing answer (logic, behavior, click paths).

S2S Workflows

  • Read

    List workflows

    List the project's live workflows.

Engagement Editor

  • Read

    Check whether the visual editor will work on a URL

    Server-side precheck for the tooltip / product-tour editor. Fetches the given URL (SSRF-guarded) and reports blockers (COOP, CSP frame-src, login/cross-origin redirect, invalid URL) so the dashboard can give the user actionable feedback instead of opening a blank editor.

Frontend Tools

  • Write

    Deliver a frontend tool execution result.

    Deliver the result of a frontend tool execution from the customer's app. Called by the Gleap SDK.

Uploads

  • Write

    Upload a file

    Upload a file and get back its permanent public URL on the Gleap CDN. Send the request as multipart/form-data with the file in a form field named file (maximum size 100 MB). Files are stored in a folder scoped to the project passed in the project header.

  • Write

    Import an image from a URL

    Import an image that is already hosted at a publicly reachable http(s) URL. The server downloads the image, verifies it really is one (PNG, JPEG, GIF, WebP, SVG or BMP; maximum 100 MB), stores a copy on the Gleap CDN, and returns the new permanent fileUrl.

Pipeline entries

  • Read

    Get an entry

    Get one entry together with its pipeline, as { entry, pipeline }. Also powers the ticket sidebar's "Pipeline" panel and the board's entry route (…/entries/:entryId). 404 when the entry isn't in this project.

  • Destructive

    Move an entry

    Move an entry to another stage of its pipeline. laneId is the target stage's id from the pipeline's lanes; an id that does not exist on the entry's pipeline is ignored rather than errored.

  • Destructive

    Update entry values

    Update an entry's field values. Keys are the pipeline's field fieldIds (see GET /pipelines/{pipelineId}/properties). Sent keys are merged into the existing values — fields you do not send are left untouched — and sending null clears a field.

  • Destructive

    Update record values through an entry

    Update the company or contact behind an entry through the pipeline's RECORD fields.

  • Destructive

    Set an entry's due date

    Set or clear the entry's due date — when the next step on it is due. Send an ISO date string to set it, or null to clear it. The board shows it on the card and turns the card red once the date has passed; the table can sort by it.

Agent Evals

  • Write

    Create Example

    POST /agentevals

Records

  • Read

    Conversation counts for a record

    Open and total conversation counts for a record, so a tab can show a real number instead of the size of whatever page happens to be loaded.

  • Read

    What is coming up on a record

    Everything on the record with a date in the future — snoozed conversations waking, pipeline due dates and date-typed attributes, merged and sorted.

  • Read

    Conversations waiting on us

    The record's open conversations, longest-waiting first. Team-wide by definition — unlike the per-agent visit stamp this replaced.

  • Read

    Record summary

    The written brief for a record. Never precomputed: this route is the only thing that ever generates one, so a record nobody opens costs nothing.

  • Write

    Refresh a record summary

    Regenerates the summary, bypassing the staleness cooldown. Rate limited to once a minute per record — the cooldown is what bounds automatic spend, so the manual path needs its own floor or it becomes the way around it.

S2S Messages

  • Read

    Get message

    Fetch a single message.

  • Write

    Rate message

    Rate a message (thumbs up / down) — typically an AI answer.

S2S Contacts

  • Read

    List contact conversations

    List the contact's conversations, most recent activity first. Bot-only conversations without human interaction are hidden — exactly the widget's conversation list.

  • Write

    Track contact events

    Track events for a contact (drives outbound messaging and workflows).

  • Write

    Create conversation

    Open a conversation for a contact, authored as the contact. Pass workflowId to start a workflow, or agentId to engage an AI agent. The contact is created on the fly if it does not exist yet.

  • Destructive

    Upsert contact

    Create or update a contact. Returns the full contact including its unread conversation count.

S2S Conversations

  • Read

    List messages

    Read the conversation's messages, oldest first, cursor-paginated (max 100 per page). Pass after = the last message id you have. Reading messages does NOT mark the conversation read — use the explicit read receipt.

  • Read

    Get pending workflow step

    The workflow step currently waiting for the contact, if any.

  • Write

    Update conversation

    Update conversation title and/or attributes (merge semantics).

  • Write

    Close conversation

    Close the conversation for the contact. Further contact messages are rejected with conversationclosed until it is reopened.

  • Write

    Reopen conversation

    Reopen a closed conversation.

  • Write

    Mark conversation read

    Mark the conversation read for the contact (explicit read receipt). Clears the contact's unread state for this conversation.

  • Write

    Typing indicator

    Signal that the contact is typing (or stopped typing). Debounce on your side; send only while a conversation is on screen.

  • Write

    Send message

    Send a message into the conversation, authored as the contact.

  • Write

    Answer workflow step

    Answer the pending workflow step (text, selection, rating, attachments) or request a human with botAction "humanHandoff".

  • Write

    Run workflow

    Run a specific workflow on this conversation (replaces any active one).

  • Destructive

    Set network logs

    Attach a network log snapshot to the conversation — the same logs Gleap.logNetwork() collects in the SDK flow. Shown to agents in the conversation's "Logs" panel. Each call replaces the previous snapshot (max 100 requests, 2 MB). Not delivered via webhooks or the stream.

  • Destructive

    Set conversation events

    Attach an event log snapshot to the conversation — the same events Gleap.trackEvent() buffers in the SDK flow and attaches when a conversation is created. Scoped to this conversation only (not the contact), so events from other sessions never mix in.

S2S Stream

  • Read

    Get stream config

    Connection parameters. Read these at startup instead of hardcoding — if the realtime infrastructure moves, your client follows automatically.

  • Write

    Authorize channel subscription

    Channel authorization — point your Pusher client's channel auth here with your server key as the Authorization header. A new consumerId takes over from the previous consumer (its connection is terminated).

  • Write

    Authenticate stream user

    User authentication (Pusher signin) — REQUIRED for server-side takeover termination to reach your connection. Configure it as the client's userAuthentication endpoint.

Ticket types

  • Read

    List boards

    List the boards (ticket types) of the project in sidebar order. Each board carries its type (the value stored on tickets), name, path, renderType and its columns in options.possibleLanes (key is the ticket status).

  • Write

    Create a board

    Create a board. The type (stored on tickets) and URL path are derived from the name.

  • Destructive

    Reorder boards

    Set the sidebar order of the boards. Boards missing from types keep their relative order after the listed ones.

  • Destructive

    Update a board

    Update one board. Only the fields sent are changed. Removing a column from options.possibleLanes moves its tickets to the Open column (or the first remaining one).

  • Destructive

    Delete a board

    Delete a board. Refused with 409 (code: PROJECTTYPENOTEMPTY) while it still has non-archived tickets.

S2S Uploads

  • Write

    Upload a file

    Multipart upload (field file, max 25 MB). Returned URLs are signed and expire — attach them to a message promptly and never persist them. Idempotency-Key is not supported on multipart uploads (re-uploading is safe: every upload mints a fresh URL).

  • Write

    Upload a voice note

    Multipart upload (field file, max 25 MB). Transcoded to MP3 server-side.

See How connections work for access and permissions, or browse all integrations.