> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Gleap

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.

**Authentication:** Bearer Token
**Categories:** Customer Support, CRM & Sales
**Tools:** 58: 29 read, 21 write, 8 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=GLEAP)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Gleap connection

   In **AgentKit > Connections**, create a Gleap connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'gleap'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'gleap_companies_list',
     toolInput: { project_id: '6512f0a1b2c3d4e5f6a7b8c9' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "gleap"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={"project_id":"6512f0a1b2c3d4e5f6a7b8c9"},
       tool_name="gleap_companies_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Gleap credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'gleap_companies_list',
  toolInput: {
    project_id: '<project_id>',
  },
  connector: 'gleap',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="gleap_companies_list",
    tool_input={
        "project_id": "<project_id>",
    },
    connection_name="gleap",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `gleap_companies_list`

List Companies · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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` (`integer`, optional): Companies per page, up to 200 (default 50). Example: 20.
- `search` (`string`, optional): Case-insensitive text to match in the company name. Example: Acme.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.

Example input: `{"project_id":"<project_id>"}`

### `gleap_company_get`

Get Company · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>"}`

### `gleap_company_members_list`

List Company Members · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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` (`integer`, optional): Contacts per page, up to 200 (default 50). Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>"}`

### `gleap_company_tickets_list`

List Company Conversations · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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` (`integer`, optional): Conversations per page, up to 100 (default 25). Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `survey_responses` (`string`, optional): Set only to list the survey responses of the company's contacts instead. Example: only. One of: `only`.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>"}`

### `gleap_current_user_get`

Get Current User · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.

Example input: `{"project_id":"<project_id>"}`

### `gleap_helpcenter_article_get`

Get Help Center Article · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `article_id` (`string`, required): Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.
- `format` (`string`, optional): Also return the content as html or markdown. Example: markdown. One of: `html`, `markdown`.

Example input: `{"article_id":"<article_id>","collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_articles_list`

List Help Center Articles · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.

Example input: `{"collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_collection_get`

Get Help Center Collection · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.

Example input: `{"collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_collections_list`

List Help Center Collections · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, optional): Collection ID to list its direct children, or all to list every collection. Example: all.
- `site` (`string`, optional): Help center site ID, or default, to list one site's collections. Example: default.

Example input: `{"project_id":"<project_id>"}`

### `gleap_messages_list`

List Messages · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.
- `before` (`string`, optional): Cursor for the next older page: the previous response's nextBefore. Only with paginated=true. Example: 6650a1b2c3d4e5f601234580.
- `bot` (`boolean`, optional): True lists only messages with the AI bot, false only the others. Example: false.
- `limit` (`integer`, optional): Maximum messages to return: default 30 in cursor mode (1-100), up to 100 otherwise. Example: 20.
- `paginated` (`boolean`, optional): True turns on cursor paging, which returns items, hasMore and nextBefore. Example: true.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `ticket` (`string`, optional): Ticket to read: its ID, dashboard ticket number or share token. Example: 6650a1b2c3d4e5f601234567.
- `type` (`string`, optional): Message type filter, such as TEXT or TEXT,NOTE (comma-separated). Example: TEXT.

Example input: `{"project_id":"<project_id>"}`

### `gleap_messages_search`

Search Messages · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_term` (`string`, required): Text to search for. Example: refund.

Example input: `{"project_id":"<project_id>","search_term":"<search_term>"}`

### `gleap_news_list`

List News Articles · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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` (`integer`, optional): Maximum articles to return, up to 100. Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Example: -createdAt.
- `without_changelogs` (`string`, optional): Set true (lowercase) to leave out changelog entries. Example: true. One of: `true`.

Example input: `{"project_id":"<project_id>"}`

### `gleap_project_users_list`

List Project Users · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.

Example input: `{"project_id":"<project_id>"}`

### `gleap_session_activities_list`

List Contact Activities · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `end_date` (`string`, optional): Only tickets created on or before this ISO date; applied only with start_date. Example: 2026-12-31.
- `limit` (`integer`, optional): Maximum tickets to return (default 50). Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `start_date` (`string`, optional): Only tickets created on or after this ISO date; applied only with end_date. Example: 2026-01-01.

Example input: `{"project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_session_events_list`

List Contact Events · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `limit` (`integer`, optional): Number of events to return, up to 300 (default 5). Example: 20.

Example input: `{"project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_session_get`

Get Contact · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_session_get_by_user_id`

Get Contact by User ID · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Your app's user ID for the contact. Example: user_12345.

Example input: `{"project_id":"<project_id>","user_id":"<user_id>"}`

### `gleap_sessions_list`

List Contacts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, optional): Only contacts of this company (external company ID). Example: acme-inc.
- `company_name` (`string`, optional): Company name word prefix. Example: Acme.
- `email` (`string`, optional): Exact email address. Example: jane@example.com.
- `limit` (`integer`, optional): Contacts per page, up to 100 (default 50). Example: 20.
- `name` (`string`, optional): Name word prefix. Example: Jane.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Example: -lastActivity.
- `type` (`string`, optional): Contact type: users (has a user ID), guests, unsubscribed, optedOutAll or bounced. Example: users. One of: `users`, `guests`, `unsubscribed`, `optedOutAll`, `bounced`.
- `user_id` (`string`, optional): Exact user ID. Example: user_12345.
- `with_feedback` (`boolean`, optional): True lists only contacts with at least one ticket. Example: true.

Example input: `{"project_id":"<project_id>"}`

### `gleap_sessions_search`

Search Contacts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_term` (`string`, required): Text to search for, at least 3 characters. Example: jane@.
- `company_id` (`string`, optional): Only contacts of this company (external company ID). Example: acme-inc.
- `field_exists` (`string`, optional): Only contacts where this field is set, such as email, userId, phone or companyId. Example: email.
- `full_contact` (`boolean`, optional): True returns full contact records instead of the 7 autocomplete fields. Example: true.
- `type` (`string`, optional): Contact type: users, guests, unsubscribed, optedOutAll or bounced. Example: users. One of: `users`, `guests`, `unsubscribed`, `optedOutAll`, `bounced`.

Example input: `{"project_id":"<project_id>","search_term":"<search_term>"}`

### `gleap_statistics_facts_get`

Get Statistics Fact · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `chart_type` (`string`, required): Statistic to get, such as NEW_TICKETS_COUNT or MEDIAN_TIME_TO_CLOSE. Example: NEW_TICKETS_COUNT.
- `project_id` (`string`, required): 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_type` (`string`, optional): Aggregation: MEDIAN or AVERAGE. Example: MEDIAN. One of: `MEDIAN`, `AVERAGE`.
- `end_date` (`string`, optional): End of the range, ISO 8601. Example: 2026-10-31T23:59:59.999Z.
- `group_interval` (`string`, optional): Grouping interval: hour, day, month or year. Example: day. One of: `hour`, `day`, `month`, `year`.
- `start_date` (`string`, optional): Start of the range, ISO 8601. Example: 2026-10-01T00:00:00.000Z.
- `timezone` (`string`, optional): Time zone for the date calculations. Example: Europe/Berlin.

Example input: `{"chart_type":"<chart_type>","project_id":"<project_id>"}`

### `gleap_survey_responses_list`

List Survey Responses · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Survey ID, from gleap_surveys_list. Example: 6650a1b2c3d4e5f601234600.
- `limit` (`integer`, optional): Maximum responses to return, up to 100. Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.

Example input: `{"project_id":"<project_id>","survey_id":"<survey_id>"}`

### `gleap_surveys_list`

List Surveys · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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` (`integer`, optional): Maximum surveys to return, up to 100. Example: 20.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Example: -createdAt.

Example input: `{"project_id":"<project_id>"}`

### `gleap_teams_list`

List Teams · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.

Example input: `{"project_id":"<project_id>"}`

### `gleap_ticket_activity_logs_list`

List Ticket Activity Logs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_get`

Get Ticket · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_types_list`

List Boards · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.

Example input: `{"project_id":"<project_id>"}`

### `gleap_tickets_count`

Count Tickets by Status · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.
- `type` (`string`, optional): Board filter, such as BUG. Example: BUG.

Example input: `{"project_id":"<project_id>"}`

### `gleap_tickets_list`

List Tickets · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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.
- `archived` (`boolean`, optional): With ignore_archived=true, set true to list archived tickets only. Example: true.
- `ignore_archived` (`boolean`, optional): True includes archived tickets; combine with archived=true for archived tickets only. Example: true.
- `is_spam` (`boolean`, optional): Set true to list spam tickets, which are hidden otherwise. Example: false.
- `limit` (`integer`, optional): Maximum tickets to return, up to 500 (default 500). Example: 20.
- `priority` (`string`, optional): Priority filter, such as HIGH or HIGH,MEDIUM. Example: HIGH.
- `skip` (`integer`, optional): Number of results to skip, for paging. Example: 0.
- `sort` (`string`, optional): Sort order: -createdAt (newest first), createdAt, -updatedAt, priority or -priority. Default is most recent activity first. Example: -createdAt.
- `status` (`string`, optional): Status filter, such as OPEN. Example: OPEN.
- `type` (`string`, optional): Board filter, such as BUG or BUG,FEATURE_REQUEST (comma-separated). Without it only the project's boards and BOT are listed. Example: BUG.

Example input: `{"project_id":"<project_id>"}`

### `gleap_tickets_search`

Search Tickets · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_term` (`string`, required): Text to search for, up to 100 characters. Example: login error.
- `add_session` (`boolean`, optional): True includes contact data on each hit. Example: true.
- `archived` (`boolean`, optional): True searches archived tickets only, false active ones only; leave empty to search both. Example: false.
- `status` (`string`, optional): Status filter, such as OPEN. Example: OPEN.
- `type` (`string`, optional): Board filter, such as BUG. Example: BUG.

Example input: `{"project_id":"<project_id>","search_term":"<search_term>"}`

### `gleap_company_member_add`

Add Company Member · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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_id` (`string`, required): Gleap ID of the contact to link, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `migrate_tickets` (`boolean`, optional): True also moves the contact's existing conversations to this company. Example: false.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_company_upsert`

Create or Update Company · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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.
- `address` (`object`, optional): Address object with line1, line2, city, state, postalCode and country; merged into the stored address. Example: {"city": "Berlin", "country": "DE"}
- `custom_data` (`object`, optional): Custom attributes as a JSON object; merged into the stored custom data. Example: {"industry": "SaaS"}
- `domain` (`string`, optional): Company domain. Example: acme.com.
- `name` (`string`, optional): Company display name. Example: Acme Inc.
- `owner_email` (`string`, optional): Email of the teammate who owns the account. Example: owner@yourcompany.com.
- `plan` (`string`, optional): Plan the company is on. Example: Enterprise.
- `sla` (`integer`, optional): Response-time SLA in seconds. Example: 3600.
- `tags` (`array`, optional): Company tags, up to 50. Replaces the stored tags; an empty list clears them. Example: ["enterprise"]
- `value` (`number`, optional): Account value, such as yearly revenue. Example: 12000.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_article_create`

Create Help Center Article · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.
- `content` (`object`, optional): 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."}]}]}
- `description` (`string`, optional): Short article description. Example: Reset a forgotten password in three steps.
- `external_id` (`string`, optional): Your own ID for the article. Example: kb-reset-password.
- `is_draft` (`boolean`, optional): True keeps the article unpublished. New articles are drafts unless false is sent. Example: false.
- `tags` (`array`, optional): Tags for the article. Example: ["account"]
- `target_audience` (`string`, optional): Who can read the article. New articles default to all. Example: all.
- `title` (`string`, optional): Article title, stored under the help center's default language. Example: How to reset your password.

Example input: `{"collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_article_update`

Update Help Center Article · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `article_id` (`string`, required): Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.
- `content` (`object`, optional): 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."}]}]}
- `description` (`string`, optional): Short article description. Example: Reset a forgotten password in three steps.
- `external_id` (`string`, optional): Your own ID for the article. Example: kb-reset-password.
- `is_draft` (`boolean`, optional): True keeps the article unpublished. New articles are drafts unless false is sent. Example: false.
- `tags` (`array`, optional): Tags for the article. Example: ["account"]
- `target_audience` (`string`, optional): Who can read the article. New articles default to all. Example: all.
- `title` (`string`, optional): Article title, stored under the help center's default language. Example: How to reset your password.

Example input: `{"article_id":"<article_id>","collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_collection_create`

Create Help Center Collection · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): 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.
- `description` (`string`, optional): Collection description. Example: Set up your account and invite your team.
- `external_id` (`string`, optional): Your own ID for the collection. Example: docs-getting-started.
- `icon_url` (`string`, optional): URL of the collection icon. Example: https://example.com/icons/rocket.png.
- `parent` (`string`, optional): ID of the parent collection, to make this a subcollection. Example: 6650a1b2c3d4e5f601234570.
- `site` (`string`, optional): Help center site of a new top-level collection: a site ID or default. Example: default.
- `target_audience` (`string`, optional): Who can read the collection. New collections default to all. Example: all.
- `title` (`string`, optional): Collection title. Example: Getting started.

Example input: `{"project_id":"<project_id>"}`

### `gleap_helpcenter_collection_update`

Update Help Center Collection · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.
- `description` (`string`, optional): Collection description. Example: Set up your account and invite your team.
- `external_id` (`string`, optional): Your own ID for the collection. Example: docs-getting-started.
- `icon_url` (`string`, optional): URL of the collection icon. Example: https://example.com/icons/rocket.png.
- `parent` (`string`, optional): ID of the parent collection, to make this a subcollection. Example: 6650a1b2c3d4e5f601234570.
- `target_audience` (`string`, optional): Who can read the collection. New collections default to all. Example: all.
- `title` (`string`, optional): Collection title. Example: Getting started.

Example input: `{"collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_message_create`

Create Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): 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` (`string`, required): ID of the ticket to post on, from gleap_tickets_list. Example: 6650a1b2c3d4e5f601234567.
- `attachments` (`array`, optional): 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"}]
- `comment` (`string`, optional): Message text as a plain string, used when markdown_comment is empty. Example: Thanks, we are looking into it.
- `is_note` (`boolean`, optional): True creates an internal note that the customer does not see. Example: false.
- `markdown_comment` (`string`, optional): Message text in Markdown; it takes precedence over comment. Example: Thanks for reporting this. We have shipped a fix in **v2.4.1**.
- `recipients` (`array`, optional): Contact IDs to send the reply to when it should go to only some of the ticket's contacts. Example: ["6650a1b2c3d4e5f601234590"]
- `reply_to` (`string`, optional): ID of a message to quote in this reply. Example: 6650a1b2c3d4e5f601234580.

Example input: `{"project_id":"<project_id>","ticket":"<ticket>"}`

### `gleap_message_update`

Update Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `data` (`object`, required): 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_id` (`string`, required): Message ID, from gleap_messages_list. Example: 6650a1b2c3d4e5f601234580.
- `project_id` (`string`, required): 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.
- `attachments` (`array`, optional): 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"}]

Example input: `{"data":{},"message_id":"<message_id>","project_id":"<project_id>"}`

### `gleap_session_create`

Create Contact · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, optional): External ID of the contact's company; the company is created if it does not exist. Example: acme-inc.
- `company_name` (`string`, optional): Name of the contact's company. Example: Acme Inc.
- `custom_data` (`object`, optional): Custom contact attributes as a JSON object. Example: {"signup_source": "webinar"}
- `email` (`string`, optional): Contact's email address. Example: jane@example.com.
- `lang` (`string`, optional): Contact language code. Example: en.
- `name` (`string`, optional): Contact's full name. Example: Jane Doe.
- `phone` (`string`, optional): Contact's phone number. Example: +14155550123.
- `plan` (`string`, optional): Plan the contact is on. Example: Pro.
- `tags` (`array`, optional): Tags for the contact. Example: ["vip"]
- `unsubscribed` (`boolean`, optional): Set true to unsubscribe the contact from emails. Example: false.
- `user_id` (`string`, optional): 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.
- `value` (`number`, optional): Value of the contact, such as monthly revenue. Example: 99.

Example input: `{"project_id":"<project_id>"}`

### `gleap_session_update`

Update Contact · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `company_id` (`string`, optional): External ID of the contact's company; the company is created if it does not exist. Example: acme-inc.
- `company_name` (`string`, optional): Name of the contact's company. Example: Acme Inc.
- `custom_data` (`object`, optional): Custom contact attributes as a JSON object. Example: {"signup_source": "webinar"}
- `email` (`string`, optional): Contact's email address. Example: jane@example.com.
- `lang` (`string`, optional): Contact language code. Example: en.
- `name` (`string`, optional): Contact's full name. Example: Jane Doe.
- `phone` (`string`, optional): Contact's phone number. Example: +14155550123.
- `plan` (`string`, optional): Plan the contact is on. Example: Pro.
- `tags` (`array`, optional): Tags for the contact. Example: ["vip"]
- `unsubscribed` (`boolean`, optional): Set true to unsubscribe the contact from emails. Example: false.
- `value` (`number`, optional): Value of the contact, such as monthly revenue. Example: 99.

Example input: `{"project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_team_create`

Create Team · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `assignment_method` (`string`, required): How new tickets are assigned to members: random, balanced, manual or circular. Example: balanced. One of: `random`, `balanced`, `manual`, `circular`.
- `members` (`array`, required): User IDs of the team members, from gleap_project_users_list. Example: ["6512f0a1b2c3d4e5f6a7b8d0"]
- `name` (`string`, required): Team name. Example: Support EMEA.
- `project_id` (`string`, required): 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_amount` (`boolean`, optional): True caps how many open tickets each member gets. Example: false.
- `select_only_online_members` (`boolean`, optional): True assigns tickets only to members who are online. Example: true.
- `task_description` (`string`, optional): One sentence on what the team handles; AI agents route tickets by it. Example: Billing questions and refunds.
- `ticket_amount` (`integer`, optional): Maximum open tickets per member when limit_ticket_amount is true. Example: 10.

Example input: `{"assignment_method":"random","members":["6512f0a1b2c3d4e5f6a7b8d0"],"name":"<name>","project_id":"<project_id>"}`

### `gleap_team_update`

Update Team · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `assignment_method` (`string`, required): How new tickets are assigned to members: random, balanced, manual or circular. Example: balanced. One of: `random`, `balanced`, `manual`, `circular`.
- `members` (`array`, required): User IDs of the team members, from gleap_project_users_list. Example: ["6512f0a1b2c3d4e5f6a7b8d0"]
- `name` (`string`, required): Team name. Example: Support EMEA.
- `project_id` (`string`, required): 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_id` (`string`, required): Team ID, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
- `limit_ticket_amount` (`boolean`, optional): True caps how many open tickets each member gets. Example: false.
- `select_only_online_members` (`boolean`, optional): True assigns tickets only to members who are online. Example: true.
- `task_description` (`string`, optional): One sentence on what the team handles; AI agents route tickets by it. Example: Billing questions and refunds.
- `ticket_amount` (`integer`, optional): Maximum open tickets per member when limit_ticket_amount is true. Example: 10.

Example input: `{"assignment_method":"random","members":["6512f0a1b2c3d4e5f6a7b8d0"],"name":"<name>","project_id":"<project_id>","team_id":"<team_id>"}`

### `gleap_ticket_archive`

Archive Ticket · Write

Archive a Gleap ticket.
Returns the archived ticket.
Use this to close a ticket and keep it. Use gleap_ticket_unarchive to restore it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_create`

Create Ticket · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): 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_data` (`object`, optional): Custom ticket fields as a JSON object of field keys to values. Example: {"plan": "pro"}
- `description` (`string`, optional): Ticket description in plain text. Example: Users cannot log in after clicking the login button on Safari.
- `due_date` (`string`, optional): Due date in ISO 8601 format. Example: 2026-12-01T17:00:00.000Z.
- `linked_tickets` (`array`, optional): IDs of existing tickets to link to this ticket. Example: ["6650a1b2c3d4e5f601234568"]
- `priority` (`string`, optional): 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_team` (`string`, optional): ID of the team to assign the ticket to, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
- `processing_user` (`string`, optional): ID of the teammate to assign the ticket to, from gleap_project_users_list. Example: 6512f0a1b2c3d4e5f6a7b8d0.
- `session` (`string`, optional): ID of the contact (session) the ticket belongs to, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `source_ticket_id` (`string`, optional): 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.
- `status` (`string`, optional): 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.
- `tags` (`array`, optional): Tags for the ticket. On update this replaces the stored tags. Example: ["billing", "urgent"]
- `title` (`string`, optional): Ticket title. Example: Login button not working.
- `type` (`string`, optional): Board (ticket type) of the ticket, such as BUG, FEATURE_REQUEST, INQUIRY or a custom board type from gleap_ticket_types_list. Example: BUG.

Example input: `{"project_id":"<project_id>"}`

### `gleap_ticket_link`

Link Tickets · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): ID of the ticket to link to. Example: 6650a1b2c3d4e5f601234568.
- `ticket_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","target_ticket_id":"<target_ticket_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_mark_spam`

Mark Ticket as Spam · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_snooze`

Snooze Ticket · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `duration` (`integer`, required): Snooze length in seconds, 0 or more. Example: 86400 for one day.
- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"duration":86400,"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_unarchive`

Unarchive Ticket · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_unlink`

Unlink Tickets · Write

Remove the link between a Gleap ticket and another ticket.
Returns the updated list of linked tickets.
Use this to undo gleap_ticket_link.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): ID of the linked ticket to unlink. Example: 6650a1b2c3d4e5f601234568.
- `ticket_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","target_ticket_id":"<target_ticket_id>","ticket_id":"<ticket_id>"}`

### `gleap_ticket_update`

Update Ticket · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.
- `custom_data` (`object`, optional): Custom ticket fields as a JSON object of field keys to values. Example: {"plan": "pro"}
- `description` (`string`, optional): Ticket description in plain text. Example: Users cannot log in after clicking the login button on Safari.
- `due_date` (`string`, optional): Due date in ISO 8601 format. Example: 2026-12-01T17:00:00.000Z.
- `linked_tickets` (`array`, optional): IDs of existing tickets to link to this ticket. Example: ["6650a1b2c3d4e5f601234568"]
- `priority` (`string`, optional): 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_team` (`string`, optional): ID of the team to assign the ticket to, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.
- `processing_user` (`string`, optional): ID of the teammate to assign the ticket to, from gleap_project_users_list. Example: 6512f0a1b2c3d4e5f6a7b8d0.
- `session` (`string`, optional): ID of the contact (session) the ticket belongs to, from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.
- `status` (`string`, optional): 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.
- `tags` (`array`, optional): Tags for the ticket. On update this replaces the stored tags. Example: ["billing", "urgent"]
- `title` (`string`, optional): Ticket title. Example: Login button not working.
- `type` (`string`, optional): Board (ticket type) of the ticket, such as BUG, FEATURE_REQUEST, INQUIRY or a custom board type from gleap_ticket_types_list. Example: BUG.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

### `gleap_tickets_merge`

Merge Tickets · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): 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_ticket` (`boolean`, required): True creates a fresh main ticket instead of merging into target_ticket_id. Example: false.
- `should_merge_contacts` (`boolean`, required): True also merges the contacts of the merged tickets. Example: false.
- `should_merge_tasks` (`boolean`, required): True moves linked sub-tickets to the main ticket. Example: true.
- `tickets_to_merge_ids` (`array`, required): IDs of the tickets to merge into the main ticket. Example: ["6650a1b2c3d4e5f601234568", "6650a1b2c3d4e5f601234569"]
- `target_ticket_id` (`string`, optional): ID of the main ticket to merge into. Required unless should_create_new_ticket is true. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","should_create_new_ticket":true,"should_merge_contacts":true,"should_merge_tasks":true,"tickets_to_merge_ids":["6650a1b2c3d4e5f601234568","6650a1b2c3d4e5f601234569"]}`

### `gleap_company_delete`

Delete Company · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>"}`

### `gleap_company_member_remove`

Remove Company Member · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): External company ID, the companyId your app sends through the SDK (not the Gleap _id). Example: acme-inc.
- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"company_id":"<company_id>","project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_helpcenter_article_delete`

Delete Help Center Article · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `article_id` (`string`, required): Help center article ID, from gleap_helpcenter_articles_list. Example: 6650a1b2c3d4e5f601234567.
- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.

Example input: `{"article_id":"<article_id>","collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_helpcenter_collection_delete`

Delete Help Center Collection · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `collection_id` (`string`, required): Help center collection ID, from gleap_helpcenter_collections_list. Example: 6650a1b2c3d4e5f601234567.
- `project_id` (`string`, required): 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.

Example input: `{"collection_id":"<collection_id>","project_id":"<project_id>"}`

### `gleap_message_delete`

Delete Message · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): Message ID, from gleap_messages_list. Example: 6650a1b2c3d4e5f601234580.
- `project_id` (`string`, required): 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.

Example input: `{"message_id":"<message_id>","project_id":"<project_id>"}`

### `gleap_session_delete`

Delete Contact · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Contact (session) ID, the Gleap _id from gleap_sessions_list. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","session_id":"<session_id>"}`

### `gleap_team_delete`

Delete Team · Destructive

Delete a Gleap team.
Returns an empty success response.
Use this to remove a team.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Team ID, from gleap_teams_list. Example: 6512f0a1b2c3d4e5f6a7b8d1.

Example input: `{"project_id":"<project_id>","team_id":"<team_id>"}`

### `gleap_ticket_delete`

Delete Ticket · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): 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_id` (`string`, required): Ticket ID: the 24-character ID, or the ticket number shown in the dashboard. Example: 6650a1b2c3d4e5f601234567.

Example input: `{"project_id":"<project_id>","ticket_id":"<ticket_id>"}`

## Related

Other Customer Support connectors ([all 38](/agentkit/connectors/?category=customer-support)):

- [ServiceNow](/agentkit/connectors/servicenow/): Scalekit connector, OAuth, 112 tools
- [Zendesk](/agentkit/connectors/zendeskoauth/): Scalekit connector, OAuth, 137 tools
- [Jira Service Management](/agentkit/connectors/jiraservicemanagement/): Scalekit connector, OAuth, 72 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
