The Gleap connector lets your AI agent act in each user's Gleap account. Each user connects their own Gleap access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.
- Tools
- 58
- What they doRead · write · destructive
- 29 · 21 · 829 read21 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Gleap connection
In AgentKit > Connections, create a Gleap connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'gleap'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Gleap:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'gleap_companies_list',toolInput: { project_id: '6512f0a1b2c3d4e5f6a7b8c9' },})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "gleap"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Gleap:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"project_id":"6512f0a1b2c3d4e5f6a7b8c9"},tool_name="gleap_companies_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Gleap credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolgleap_companies_listList the companies of a Gleap project, most recently seen first, optionally filtered by name.Read-onlyList Companies
List the companies of a Gleap project, most recently seen first, optionally filtered by name. Returns a summary per company: companyId, name, plan, value, domain, lastSeenAt and createdAt. Use this to browse or find companies. Use gleap_company_get for the full record.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limitinteger- Companies per page, up to 200 (default 50). Example: 20.
searchstring- Case-insensitive text to match in the company name. Example: Acme.
skipinteger- Number of results to skip, for paging. Example: 0.
gleap_company_getGet one Gleap company by its external company ID.Read-onlyGet Company
Get one Gleap company by its external company ID. Returns the company with name, plan, domain, value, SLA, tags, address, custom data and owner. Use this for a company's details. Use gleap_company_members_list for its contacts.
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_company_members_listList the contacts linked to a Gleap company, most recently active first.Read-onlyList Company Members
List the contacts linked to a Gleap company, most recently active first. Returns each contact's _id, name, email, userId, avatar and lastActivity. Use this for a company's contacts. Use gleap_company_member_add to link another contact.
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limitinteger- Contacts per page, up to 200 (default 50). Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
gleap_company_tickets_listList the conversations stamped with a Gleap company, newest activity first.Read-onlyList Company Conversations
List the conversations stamped with a Gleap company, newest activity first. Returns the company's tickets, or its contacts' survey responses with survey_responses=only. Use this for a company's support history. Use gleap_session_activities_list for one contact.
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limitinteger- Conversations per page, up to 100 (default 25). Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
survey_responsesstring- Set only to list the survey responses of the company's contacts instead. Example: only.one of
only
gleap_current_user_getGet the Gleap user the API key belongs to.Read-onlyGet Current User
Get the Gleap user the API key belongs to. Returns the user's ID, name, email and settings. Use this to check the connection or find your own user ID.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_helpcenter_article_getGet one Gleap help center article, optionally with its content converted to HTML or Markdown.Read-onlyGet Help Center Article
Get one Gleap help center article, optionally with its content converted to HTML or Markdown. Returns the article with title, description, editor JSON content and settings, plus contentHtml or contentMarkdown when format is set. Use this to read an article. Use gleap_helpcenter_articles_list to find it.
Inputs
article_idstringrequired- Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
formatstring- Also return the content as html or markdown. Example: markdown.one of
htmlmarkdown
gleap_helpcenter_articles_listList every article in a Gleap help center collection, published and unpublished, in order.Read-onlyList Help Center Articles
List every article in a Gleap help center collection, published and unpublished, in order. Returns the articles with ID, title, description, draft state and dates; not paginated. Use this to browse a collection. Use gleap_helpcenter_article_get for one article's content.
Inputs
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_helpcenter_collection_getGet one Gleap help center collection.Read-onlyGet Help Center Collection
Get one Gleap help center collection. Returns the collection with title, description, icon, parent and audience settings. Use this for a collection's details. Use gleap_helpcenter_articles_list for its articles.
Inputs
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_helpcenter_collections_listList help center collections of a Gleap project, top-level by default.Read-onlyList Help Center Collections
List help center collections of a Gleap project, top-level by default. Returns collections sorted by position, each with articlesCount and subCollectionsCount. Use this to find collections. Use gleap_helpcenter_articles_list for a collection's articles.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
parent_idstring- Collection ID to list its direct children, or all to list every collection. Example: all.
sitestring- Help center site ID, or default, to list one site's collections. Example: default.
gleap_messages_listList the messages of Gleap tickets, oldest first within each page.Read-onlyList Messages
List the messages of Gleap tickets, oldest first within each page. Returns messages with ID, ticket, type, content, author and dates; with paginated=true it returns items, hasMore and nextBefore. Use this to read a ticket's conversation. Use gleap_messages_search to find messages by text.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
beforestring- Cursor for the next older page: the previous response's nextBefore. Only with paginated=true. Example: 6650a1b2c3d4e5f601234580.
botboolean- True lists only messages with the AI bot, false only the others. Example: false.
limitinteger- Maximum messages to return: default 30 in cursor mode (1-100), up to 100 otherwise. Example: 20.
paginatedboolean- True turns on cursor paging, which returns items, hasMore and nextBefore. Example: true.
skipinteger- Number of results to skip, for paging. Example: 0.
ticketstring- Ticket to read: its ID, dashboard ticket number or share token. Example: 6650a1b2c3d4e5f601234567.
typestring- Message type filter, such as TEXT or TEXT,NOTE (comma-separated). Example: TEXT.
gleap_messages_searchSearch the messages of a Gleap project by text.Read-onlySearch Messages
Search the messages of a Gleap project by text. Returns the matching messages. Use this to find a message by words. Use gleap_messages_list to read one ticket's messages.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
search_termstringrequired- Text to search for. Example: refund.
gleap_news_listList the news articles (product updates) of a Gleap project, newest first.Read-onlyList News Articles
List the news articles (product updates) of a Gleap project, newest first. Returns the articles with ID, subject, content, status and dates. Use this to read what has been announced to customers.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limitinteger- Maximum articles to return, up to 100. Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
sortstring- Sort field, with a leading - for descending. Example: -createdAt.
without_changelogsstring- Set true (lowercase) to leave out changelog entries. Example: true.one of
true
gleap_project_users_listList everyone who can access a Gleap project: project members and organisation members.Read-onlyList Project Users
List everyone who can access a Gleap project: project members and organisation members. Returns users with ID, name, email, type (project or organisation) and role. Use this to find user IDs for assigning tickets or building teams.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_session_activities_listList the tickets of a Gleap contact, newest activity first, including tickets of other contacts with the same email.Read-onlyList Contact Activities
List the tickets of a Gleap contact, newest activity first, including tickets of other contacts with the same email. Returns the contact's tickets. Use this for a contact's ticket history. Use gleap_session_events_list for tracked events.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
end_datestring- Only tickets created on or before this ISO date; applied only with start_date. Example: 2026-12-31.
limitinteger- Maximum tickets to return (default 50). Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
start_datestring- Only tickets created on or after this ISO date; applied only with end_date. Example: 2026-01-01.
gleap_session_events_listList the tracked events of a Gleap contact, newest first.Read-onlyList Contact Events
List the tracked events of a Gleap contact, newest first. Returns the events with name, data and date. Use this for a contact's product events. Use gleap_session_activities_list for their tickets.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
limitinteger- Number of events to return, up to 300 (default 5). Example: 20.
gleap_session_getGet one contact (session) of a Gleap project by its Gleap ID.Read-onlyGet Contact
Get one contact (session) of a Gleap project by its Gleap ID. Returns the contact with name, email, user ID, company, plan, tags, custom data and activity dates. Use this with a Gleap ID. Use gleap_session_get_by_user_id with your app's user ID.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
gleap_session_get_by_user_idGet a Gleap contact by your app's user ID (the ID passed to the SDK identify call).Read-onlyGet Contact by User ID
Get a Gleap contact by your app's user ID (the ID passed to the SDK identify call). Returns the contact; the API responds 404 when no contact has that user ID. Use this with your app's user ID. Use gleap_session_get with a Gleap ID.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
user_idstringrequired- Your app's user ID for the contact. Example: user_12345.
gleap_sessions_listList the contacts (sessions) of a Gleap project, 50 per page by default, up to the first 10,000.Read-onlyList Contacts
List the contacts (sessions) of a Gleap project, 50 per page by default, up to the first 10,000. Returns contacts with ID, name, email, user ID, company and activity dates. Use this to browse or filter contacts. Use gleap_sessions_search for autocomplete search by text.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
company_idstring- Only contacts of this company (external company ID). Example: acme-inc.
company_namestring- Company name word prefix. Example: Acme.
emailstring- Exact email address. Example: jane@example.com.
limitinteger- Contacts per page, up to 100 (default 50). Example: 20.
namestring- Name word prefix. Example: Jane.
skipinteger- Number of results to skip, for paging. Example: 0.
sortstring- Sort field, with a leading - for descending. Example: -lastActivity.
typestring- Contact type: users (has a user ID), guests, unsubscribed, optedOutAll or bounced. Example: users.one of
usersguestsunsubscribedoptedOutAllbounced user_idstring- Exact user ID. Example: user_12345.
with_feedbackboolean- True lists only contacts with at least one ticket. Example: true.
gleap_sessions_searchSearch the contacts (sessions) of a Gleap project by name, email, user ID, company or phone.Read-onlySearch Contacts
Search the contacts (sessions) of a Gleap project by name, email, user ID, company or phone. Returns up to 50 matches with ID, email, user ID, name, company and phone, or full contacts with full_contact=true. Use this to find a contact by text. Use gleap_sessions_list to filter exactly.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
search_termstringrequired- Text to search for, at least 3 characters. Example: jane@.
company_idstring- Only contacts of this company (external company ID). Example: acme-inc.
field_existsstring- Only contacts where this field is set, such as email, userId, phone or companyId. Example: email.
full_contactboolean- True returns full contact records instead of the 7 autocomplete fields. Example: true.
typestring- Contact type: users, guests, unsubscribed, optedOutAll or bounced. Example: users.one of
usersguestsunsubscribedoptedOutAllbounced
gleap_statistics_facts_getGet a support statistic for a Gleap project, such as the number of new tickets or the median time to close, over a date range.Read-onlyGet Statistics Fact
Get a support statistic for a Gleap project, such as the number of new tickets or the median time to close, over a date range. Returns the fact value, and the previous period's value for comparison where available. Use this for reporting numbers.
Inputs
chart_typestringrequired- Statistic to get, such as NEW_TICKETS_COUNT or MEDIAN_TIME_TO_CLOSE. Example: NEW_TICKETS_COUNT.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
aggs_typestring- Aggregation: MEDIAN or AVERAGE. Example: MEDIAN.one of
MEDIANAVERAGE end_datestring- End of the range, ISO 8601. Example: 2026-10-31T23:59:59.999Z.
group_intervalstring- Grouping interval: hour, day, month or year. Example: day.one of
hourdaymonthyear start_datestring- Start of the range, ISO 8601. Example: 2026-10-01T00:00:00.000Z.
timezonestring- Time zone for the date calculations. Example: Europe/Berlin.
gleap_survey_responses_listList the responses to a Gleap survey, unread first, then newest first.Read-onlyList Survey Responses
List the responses to a Gleap survey, unread first, then newest first. Returns the responses with answers, contact and date. Use this to read survey results. Use gleap_surveys_list to find the survey ID.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
survey_idstringrequired- Survey ID, from gleap_surveys_list. Example: 6650a1b2c3d4e5f601234600.
limitinteger- Maximum responses to return, up to 100. Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
gleap_surveys_listList the surveys of a Gleap project, newest first.Read-onlyList Surveys
List the surveys of a Gleap project, newest first. Returns surveys with ID, name, status and settings. Use this to find survey IDs. Use gleap_survey_responses_list for a survey's answers.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limitinteger- Maximum surveys to return, up to 100. Example: 20.
skipinteger- Number of results to skip, for paging. Example: 0.
sortstring- Sort field, with a leading - for descending. Example: -createdAt.
gleap_teams_listList the teams of a Gleap project.Read-onlyList Teams
List the teams of a Gleap project. Returns teams with ID, name, members and assignment method. Use this to find team IDs for assigning tickets.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_ticket_activity_logs_listList the activity log of a Gleap ticket.Read-onlyList Ticket Activity Logs
List the activity log of a Gleap ticket. Returns the log entries, such as status changes and assignments, with who made them and when. Use this for a ticket's change history. Use gleap_messages_list for its messages.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_getGet one ticket of a Gleap project.Read-onlyGet Ticket
Get one ticket of a Gleap project. Returns the full ticket with title, description, type, status, priority, contact, assignee, tags and custom data. Use this for one ticket's details. Use gleap_messages_list for its conversation.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_types_listList the boards (ticket types) of a Gleap project in sidebar order.Read-onlyList Boards
List the boards (ticket types) of a Gleap project in sidebar order. Returns each board's type, name, path and its columns, whose keys are the ticket statuses. Use this to find valid type and status values before creating or updating tickets.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_tickets_countCount the tickets of a Gleap project per status, excluding archived, hidden, spam and merged tickets.Read-onlyCount Tickets by Status
Count the tickets of a Gleap project per status, excluding archived, hidden, spam and merged tickets. Returns an array of objects with the status as _id and its count. Use this for a quick status overview. Use gleap_tickets_list to fetch the tickets.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
typestring- Board filter, such as BUG. Example: BUG.
gleap_tickets_listList tickets in a Gleap project, filtered by board, status or priority, with sorting and paging.Read-onlyList Tickets
List tickets in a Gleap project, filtered by board, status or priority, with sorting and paging. Returns an array of tickets with ID, title, type, status, priority, contact and dates. Use this to browse tickets. Use gleap_tickets_search for a full-text query and gleap_ticket_get for one ticket.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
archivedboolean- With ignore_archived=true, set true to list archived tickets only. Example: true.
ignore_archivedboolean- True includes archived tickets; combine with archived=true for archived tickets only. Example: true.
is_spamboolean- Set true to list spam tickets, which are hidden otherwise. Example: false.
limitinteger- Maximum tickets to return, up to 500 (default 500). Example: 20.
prioritystring- Priority filter, such as HIGH or HIGH,MEDIUM. Example: HIGH.
skipinteger- Number of results to skip, for paging. Example: 0.
sortstring- Sort order: -createdAt (newest first), createdAt, -updatedAt, priority or -priority. Default is most recent activity first. Example: -createdAt.
statusstring- Status filter, such as OPEN. Example: OPEN.
typestring- Board filter, such as BUG or BUG,FEATURE_REQUEST (comma-separated). Without it only the project's boards and BOT are listed. Example: BUG.
gleap_tickets_searchSearch the tickets of a Gleap project and their comments by text.Read-onlySearch Tickets
Search the tickets of a Gleap project and their comments by text. Returns up to 30 hits ordered by relevance. Use this to find tickets by words. Use gleap_tickets_list to filter by board or status.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
search_termstringrequired- Text to search for, up to 100 characters. Example: login error.
add_sessionboolean- True includes contact data on each hit. Example: true.
archivedboolean- True searches archived tickets only, false active ones only; leave empty to search both. Example: false.
statusstring- Status filter, such as OPEN. Example: OPEN.
typestring- Board filter, such as BUG. Example: BUG.
gleap_company_member_addLink a contact to a Gleap company.WriteAdd Company Member
Link a contact to a Gleap company. Returns the updated contact link. Use this to add a contact to a company. Use gleap_company_member_remove to unlink it.
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Gleap ID of the contact to link, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
migrate_ticketsboolean- True also moves the contact's existing conversations to this company. Example: false.
gleap_company_upsertCreate or update a Gleap company by its external company ID.WriteCreate or Update Company
Create or update a Gleap company by its external company ID. Returns the saved company. Use this to add or change a company. tags replaces the stored list; address and custom_data are merged.
- Idempotent
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
addressobject- Address object with line1, line2, city, state, postalCode and country; merged into the stored address. Example: {"city": "Berlin", "country": "DE"}
custom_dataobject- Custom attributes as a JSON object; merged into the stored custom data. Example: {"industry": "SaaS"}
domainstring- Company domain. Example: acme.com.
namestring- Company display name. Example: Acme Inc.
owner_emailstring- Email of the teammate who owns the account. Example: owner@yourcompany.com.
planstring- Plan the company is on. Example: Enterprise.
slainteger- Response-time SLA in seconds. Example: 3600.
tagsarray- Company tags, up to 50. Replaces the stored tags; an empty list clears them. Example: ["enterprise"]
valuenumber- Account value, such as yearly revenue. Example: 12000.
gleap_helpcenter_article_createCreate an article in a Gleap help center collection; it stays a draft unless is_draft is false.WriteCreate Help Center Article
Create an article in a Gleap help center collection; it stays a draft unless is_draft is false. Returns the created article with its ID. Use this to add an article. Use gleap_helpcenter_article_update to edit it.
Inputs
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
contentobject- Article body as a TipTap (ProseMirror) document JSON object. Images are image nodes whose src is a hosted URL. Example: {"type": "doc", "content": [{"type": "paragraph", "content": [{"type": "text", "text": "Open Settings and click Reset password."}]}]}
descriptionstring- Short article description. Example: Reset a forgotten password in three steps.
external_idstring- Your own ID for the article. Example: kb-reset-password.
is_draftboolean- True keeps the article unpublished. New articles are drafts unless false is sent. Example: false.
tagsarray- Tags for the article. Example: ["account"]
target_audiencestring- Who can read the article. New articles default to all. Example: all.
titlestring- Article title, stored under the help center's default language. Example: How to reset your password.
gleap_helpcenter_article_updateUpdate a Gleap help center article's title, description, content, draft state or settings.WriteUpdate Help Center Article
Update a Gleap help center article's title, description, content, draft state or settings. Returns the updated article. Use this to edit or publish an article. Use gleap_helpcenter_article_create for a new one.
- Idempotent
Inputs
article_idstringrequired- Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
contentobject- Article body as a TipTap (ProseMirror) document JSON object. Images are image nodes whose src is a hosted URL. Example: {"type": "doc", "content": [{"type": "paragraph", "content": [{"type": "text", "text": "Open Settings and click Reset password."}]}]}
descriptionstring- Short article description. Example: Reset a forgotten password in three steps.
external_idstring- Your own ID for the article. Example: kb-reset-password.
is_draftboolean- True keeps the article unpublished. New articles are drafts unless false is sent. Example: false.
tagsarray- Tags for the article. Example: ["account"]
target_audiencestring- Who can read the article. New articles default to all. Example: all.
titlestring- Article title, stored under the help center's default language. Example: How to reset your password.
gleap_helpcenter_collection_createCreate a Gleap help center collection, optionally inside a parent collection.WriteCreate Help Center Collection
Create a Gleap help center collection, optionally inside a parent collection. Returns the created collection with its ID. Use this to add a collection. Use gleap_helpcenter_article_create to add articles to it.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
descriptionstring- Collection description. Example: Set up your account and invite your team.
external_idstring- Your own ID for the collection. Example: docs-getting-started.
icon_urlstring- URL of the collection icon. Example: https://example.com/icons/rocket.png.
parentstring- ID of the parent collection, to make this a subcollection. Example: 6650a1b2c3d4e5f601234570.
sitestring- Help center site of a new top-level collection: a site ID or default. Example: default.
target_audiencestring- Who can read the collection. New collections default to all. Example: all.
titlestring- Collection title. Example: Getting started.
gleap_helpcenter_collection_updateUpdate a Gleap help center collection; audience changes also apply to its articles and subcollections.WriteUpdate Help Center Collection
Update a Gleap help center collection; audience changes also apply to its articles and subcollections. Returns the updated collection. Use this to rename or move a collection.
- Idempotent
Inputs
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
descriptionstring- Collection description. Example: Set up your account and invite your team.
external_idstring- Your own ID for the collection. Example: docs-getting-started.
icon_urlstring- URL of the collection icon. Example: https://example.com/icons/rocket.png.
parentstring- ID of the parent collection, to make this a subcollection. Example: 6650a1b2c3d4e5f601234570.
target_audiencestring- Who can read the collection. New collections default to all. Example: all.
titlestring- Collection title. Example: Getting started.
gleap_message_createPost a reply or internal note on a Gleap ticket as the API key's user.WriteCreate Message
Post a reply or internal note on a Gleap ticket as the API key's user. Returns the created message with its ID and content. Use this to answer a customer or add a note. Use gleap_ticket_create to open a new ticket.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticketstringrequired- ID of the ticket to post on, from gleap_tickets_list. Example: 6650a1b2c3d4e5f601234567.
attachmentsarray- Files to attach, each an object with name, url and an optional MIME type. Example: [{"name": "invoice.pdf", "url": "https://example.com/invoice.pdf", "type": "application/pdf"}]
commentstring- Message text as a plain string, used when markdown_comment is empty. Example: Thanks, we are looking into it.
is_noteboolean- True creates an internal note that the customer does not see. Example: false.
markdown_commentstring- Message text in Markdown; it takes precedence over comment. Example: Thanks for reporting this. We have shipped a fix in **v2.4.1**.
recipientsarray- Contact IDs to send the reply to when it should go to only some of the ticket's contacts. Example: ["6650a1b2c3d4e5f601234590"]
reply_tostring- ID of a message to quote in this reply. Example: 6650a1b2c3d4e5f601234580.
gleap_message_updateEdit your own recent Gleap message: only messages under 2 minutes old that the contact has not read can be edited.WriteUpdate Message
Edit your own recent Gleap message: only messages under 2 minutes old that the contact has not read can be edited. Returns the updated message. Use this to fix a reply you just sent. Use gleap_message_delete to remove it.
- Idempotent
Inputs
dataobjectrequired- New message content; replaces the stored content. Put the text as a TipTap document under content. Example: {"content": {"type": "doc", "content": [{"type": "paragraph", "content": [{"type": "text", "text": "Corrected reply."}]}]}}
message_idstringrequired- Message ID, from gleap_messages_list. Example: 6650a1b2c3d4e5f601234580.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
attachmentsarray- Files attached to the message, each an object with name, url and an optional MIME type. Example: [{"name": "invoice.pdf", "url": "https://example.com/invoice.pdf"}]
gleap_session_createCreate a contact (session) in a Gleap project, or update the existing contact with the same user_id or email.WriteCreate Contact
Create a contact (session) in a Gleap project, or update the existing contact with the same user_id or email. Returns the contact with its Gleap ID and fields. Use this to add or upsert a contact. Use gleap_session_update to change a contact by its Gleap ID.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
company_idstring- External ID of the contact's company; the company is created if it does not exist. Example: acme-inc.
company_namestring- Name of the contact's company. Example: Acme Inc.
custom_dataobject- Custom contact attributes as a JSON object. Example: {"signup_source": "webinar"}
emailstring- Contact's email address. Example: jane@example.com.
langstring- Contact language code. Example: en.
namestring- Contact's full name. Example: Jane Doe.
phonestring- Contact's phone number. Example: +14155550123.
planstring- Plan the contact is on. Example: Pro.
tagsarray- Tags for the contact. Example: ["vip"]
unsubscribedboolean- Set true to unsubscribe the contact from emails. Example: false.
user_idstring- Your app's user ID for the contact. When set, an existing contact with this ID is updated instead of a new one created. Example: user_12345.
valuenumber- Value of the contact, such as monthly revenue. Example: 99.
gleap_session_updateUpdate a contact (session) in a Gleap project; setting company_id creates the company if needed.WriteUpdate Contact
Update a contact (session) in a Gleap project; setting company_id creates the company if needed. Returns the updated contact. Use this to change a contact by its Gleap ID. Use gleap_session_create to upsert by user ID or email.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
company_idstring- External ID of the contact's company; the company is created if it does not exist. Example: acme-inc.
company_namestring- Name of the contact's company. Example: Acme Inc.
custom_dataobject- Custom contact attributes as a JSON object. Example: {"signup_source": "webinar"}
emailstring- Contact's email address. Example: jane@example.com.
langstring- Contact language code. Example: en.
namestring- Contact's full name. Example: Jane Doe.
phonestring- Contact's phone number. Example: +14155550123.
planstring- Plan the contact is on. Example: Pro.
tagsarray- Tags for the contact. Example: ["vip"]
unsubscribedboolean- Set true to unsubscribe the contact from emails. Example: false.
valuenumber- Value of the contact, such as monthly revenue. Example: 99.
gleap_team_createCreate a team in a Gleap project.WriteCreate Team
Create a team in a Gleap project. Returns the created team with its ID. Use this to add a team. Use gleap_team_update to change one.
Inputs
assignment_methodstringrequired- How new tickets are assigned to members: random, balanced, manual or circular. Example: balanced.one of
randombalancedmanualcircular membersarrayrequired- User IDs of the team members, from gleap_project_users_list. Example: ["6512f0a1b2c3d4e5f6a7b8d0"]
namestringrequired- Team name. Example: Support EMEA.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
limit_ticket_amountboolean- True caps how many open tickets each member gets. Example: false.
select_only_online_membersboolean- True assigns tickets only to members who are online. Example: true.
task_descriptionstring- One sentence on what the team handles; AI agents route tickets by it. Example: Billing questions and refunds.
ticket_amountinteger- Maximum open tickets per member when limit_ticket_amount is true. Example: 10.
gleap_team_updateUpdate a Gleap team; name, assignment method and members are required on every update.WriteUpdate Team
Update a Gleap team; name, assignment method and members are required on every update. Returns the updated team. Use this to change a team. Use gleap_teams_list to read its current values first.
- Idempotent
Inputs
assignment_methodstringrequired- How new tickets are assigned to members: random, balanced, manual or circular. Example: balanced.one of
randombalancedmanualcircular membersarrayrequired- User IDs of the team members, from gleap_project_users_list. Example: ["6512f0a1b2c3d4e5f6a7b8d0"]
namestringrequired- Team name. Example: Support EMEA.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
team_idstringrequired- Team ID, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
limit_ticket_amountboolean- True caps how many open tickets each member gets. Example: false.
select_only_online_membersboolean- True assigns tickets only to members who are online. Example: true.
task_descriptionstring- One sentence on what the team handles; AI agents route tickets by it. Example: Billing questions and refunds.
ticket_amountinteger- Maximum open tickets per member when limit_ticket_amount is true. Example: 10.
gleap_ticket_archiveArchive a Gleap ticket.WriteArchive Ticket
Archive a Gleap ticket. Returns the archived ticket. Use this to close a ticket and keep it. Use gleap_ticket_unarchive to restore it.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_createCreate a ticket in a Gleap project, such as a bug, feature request or support conversation.WriteCreate Ticket
Create a ticket in a Gleap project, such as a bug, feature request or support conversation. Returns the created ticket with its ID, bug number, status and fields. Use this to log a new ticket. Use gleap_message_create to reply on an existing ticket.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
custom_dataobject- Custom ticket fields as a JSON object of field keys to values. Example: {"plan": "pro"}
descriptionstring- Ticket description in plain text. Example: Users cannot log in after clicking the login button on Safari.
due_datestring- Due date in ISO 8601 format. Example: 2026-12-01T17:00:00.000Z.
linked_ticketsarray- IDs of existing tickets to link to this ticket. Example: ["6650a1b2c3d4e5f601234568"]
prioritystring- Priority key of the ticket's board: LOW, MEDIUM, HIGH or a custom key. An unknown value falls back to the board's default priority. Example: HIGH.
processing_teamstring- ID of the team to assign the ticket to, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
processing_userstring- ID of the teammate to assign the ticket to, from gleap_project_users_list. Example: 6512f0a1b2c3d4e5f6a7b8d0.
sessionstring- ID of the contact (session) the ticket belongs to, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
source_ticket_idstring- Create this ticket from another ticket of the project, for example a bug from a customer conversation. Without session, the new ticket takes the source ticket's contact and company; both tickets are linked. Example: 6650a1b2c3d4e5f601234569.
statusstring- Status key of a column on the ticket's board, such as OPEN, INPROGRESS or DONE. gleap_ticket_types_list lists each board's columns. Example: OPEN.
tagsarray- Tags for the ticket. On update this replaces the stored tags. Example: ["billing", "urgent"]
titlestring- Ticket title. Example: Login button not working.
typestring- Board (ticket type) of the ticket, such as BUG, FEATURE_REQUEST, INQUIRY or a custom board type from gleap_ticket_types_list. Example: BUG.
gleap_ticket_linkLink a Gleap ticket to another ticket in both directions; linking to a tracker ticket also archives the regular ticket.WriteLink Tickets
Link a Gleap ticket to another ticket in both directions; linking to a tracker ticket also archives the regular ticket. Returns the updated list of linked tickets. Use this to relate tickets. Use gleap_ticket_unlink to remove the link and gleap_tickets_merge to combine them.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
target_ticket_idstringrequired- ID of the ticket to link to. Example: 6650a1b2c3d4e5f601234568.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_mark_spamMark a Gleap ticket as spam: it is archived to the spam tab and its contact is blocked, so their future tickets are flagged as spam too.WriteMark Ticket as Spam
Mark a Gleap ticket as spam: it is archived to the spam tab and its contact is blocked, so their future tickets are flagged as spam too. Returns the updated ticket. Use this for unwanted messages. Use gleap_ticket_unarchive to undo it.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_snoozeSnooze a Gleap ticket for a number of seconds; its status becomes SNOOZED and it reopens when the time is up.WriteSnooze Ticket
Snooze a Gleap ticket for a number of seconds; its status becomes SNOOZED and it reopens when the time is up. Returns the updated ticket. Use this to hide a ticket until later. Use gleap_ticket_archive to close it.
- Idempotent
Inputs
durationintegerrequired- Snooze length in seconds, 0 or more. Example: 86400 for one day.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_unarchiveUnarchive a Gleap ticket; on a spam ticket this also clears the spam flag and unblocks the contact.WriteUnarchive Ticket
Unarchive a Gleap ticket; on a spam ticket this also clears the spam flag and unblocks the contact. Returns the restored ticket. Use this to reopen an archived ticket or undo gleap_ticket_mark_spam.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_unlinkRemove the link between a Gleap ticket and another ticket.WriteUnlink Tickets
Remove the link between a Gleap ticket and another ticket. Returns the updated list of linked tickets. Use this to undo gleap_ticket_link.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
target_ticket_idstringrequired- ID of the linked ticket to unlink. Example: 6650a1b2c3d4e5f601234568.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
gleap_ticket_updateUpdate a ticket in a Gleap project: title, description, board, status, priority, assignee, tags or custom data.WriteUpdate Ticket
Update a ticket in a Gleap project: title, description, board, status, priority, assignee, tags or custom data. Returns the updated ticket. Use this to change ticket fields. Use gleap_ticket_archive, gleap_ticket_snooze or gleap_ticket_mark_spam for those actions.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
custom_dataobject- Custom ticket fields as a JSON object of field keys to values. Example: {"plan": "pro"}
descriptionstring- Ticket description in plain text. Example: Users cannot log in after clicking the login button on Safari.
due_datestring- Due date in ISO 8601 format. Example: 2026-12-01T17:00:00.000Z.
linked_ticketsarray- IDs of existing tickets to link to this ticket. Example: ["6650a1b2c3d4e5f601234568"]
prioritystring- Priority key of the ticket's board: LOW, MEDIUM, HIGH or a custom key. An unknown value falls back to the board's default priority. Example: HIGH.
processing_teamstring- ID of the team to assign the ticket to, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
processing_userstring- ID of the teammate to assign the ticket to, from gleap_project_users_list. Example: 6512f0a1b2c3d4e5f6a7b8d0.
sessionstring- ID of the contact (session) the ticket belongs to, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
statusstring- Status key of a column on the ticket's board, such as OPEN, INPROGRESS or DONE. gleap_ticket_types_list lists each board's columns. Example: OPEN.
tagsarray- Tags for the ticket. On update this replaces the stored tags. Example: ["billing", "urgent"]
titlestring- Ticket title. Example: Login button not working.
typestring- Board (ticket type) of the ticket, such as BUG, FEATURE_REQUEST, INQUIRY or a custom board type from gleap_ticket_types_list. Example: BUG.
gleap_tickets_mergeMerge several Gleap tickets into one main ticket; merged tickets are archived and linked to it.WriteMerge Tickets
Merge several Gleap tickets into one main ticket; merged tickets are archived and linked to it. Returns the resulting main ticket. Use this to combine duplicates. Use gleap_ticket_link to only relate two tickets.
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
should_create_new_ticketbooleanrequired- True creates a fresh main ticket instead of merging into target_ticket_id. Example: false.
should_merge_contactsbooleanrequired- True also merges the contacts of the merged tickets. Example: false.
should_merge_tasksbooleanrequired- True moves linked sub-tickets to the main ticket. Example: true.
tickets_to_merge_idsarrayrequired- IDs of the tickets to merge into the main ticket. Example: ["6650a1b2c3d4e5f601234568", "6650a1b2c3d4e5f601234569"]
target_ticket_idstring- ID of the main ticket to merge into. Required unless should_create_new_ticket is true. Example: 6650a1b2c3d4e5f601234567.
gleap_company_deleteDelete a Gleap company; contacts keep their company ID, so an SDK that still sends it re-creates the company.DestructiveDelete Company
Delete a Gleap company; contacts keep their company ID, so an SDK that still sends it re-creates the company. Returns an empty success response. Use this to remove a company record.
- Idempotent
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_company_member_removeUnlink a contact from a Gleap company; existing conversations keep their company.DestructiveRemove Company Member
Unlink a contact from a Gleap company; existing conversations keep their company. Returns an empty success response. Use this to undo gleap_company_member_add.
- Idempotent
Inputs
company_idstringrequired- External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
gleap_helpcenter_article_deleteDelete a Gleap help center article.DestructiveDelete Help Center Article
Delete a Gleap help center article. Returns an empty success response. Use this to remove an article. Use gleap_helpcenter_article_update with is_draft true to unpublish it instead.
- Idempotent
Inputs
article_idstringrequired- Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_helpcenter_collection_deleteDelete an empty Gleap help center collection; the API rejects it with 409 while it still has articles.DestructiveDelete Help Center Collection
Delete an empty Gleap help center collection; the API rejects it with 409 while it still has articles. Returns success true. Use this after deleting or moving the collection's articles and subcollections.
- Idempotent
Inputs
collection_idstringrequired- Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_message_deletePermanently delete a Gleap message and its thread replies; this cannot be undone and sends no webhook.DestructiveDelete Message
Permanently delete a Gleap message and its thread replies; this cannot be undone and sends no webhook. Returns an empty success response. Use this to remove a message. Use gleap_message_update to correct it instead.
- Idempotent
Inputs
message_idstringrequired- Message ID, from gleap_messages_list. Example: 6650a1b2c3d4e5f601234580.
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
gleap_session_deleteDelete a Gleap contact and permanently delete every ticket attached to it, without sending ticket events or webhooks.DestructiveDelete Contact
Delete a Gleap contact and permanently delete every ticket attached to it, without sending ticket events or webhooks. Returns an empty success response. Use this only to remove a contact and its tickets for good.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
session_idstringrequired- Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
gleap_team_deleteDelete a Gleap team.DestructiveDelete Team
Delete a Gleap team. Returns an empty success response. Use this to remove a team.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
team_idstringrequired- Team ID, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
gleap_ticket_deletePermanently delete a ticket, its duplicates, messages and replay data; this cannot be undone.DestructiveDelete Ticket
Permanently delete a ticket, its duplicates, messages and replay data; this cannot be undone. Returns an empty success response. Use this only to remove a ticket for good. Use gleap_ticket_archive to close it and keep the record.
- Idempotent
Inputs
project_idstringrequired- ID of the Gleap project to work in, sent in the Project header. Copy it from Settings > Project > General in the Gleap dashboard; it is the ID your SDK is initialized with. Example: 6512f0a1b2c3d4e5f6a7b8c9.
ticket_idstringrequired- Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
No tools match.