Gleap

https://docs.gleap.io/
Admin
Gleap is an all-in-one customer feedback tool that integrates into apps and websites to enable...
Tokens:271,083
Snippets:2,117
Trust Score:8.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Gleap Admin SDK

Source: https://docs.gleap.io/documentation/server/nodejs

Install the package via npm to begin using the SDK.

```bash
npm install gleap-admin --save
```

--------------------------------

### Install Gleap Cordova Plugin

Source: https://docs.gleap.io/documentation/cordova/README

Install the Gleap package using the Cordova CLI.

```bash
cordova plugin add cordova-plugin-gleap
```

--------------------------------

### CocoaPods Installation

Source: https://docs.gleap.io/documentation/ios/README

Commands to add the Gleap dependency to your Podfile and install it.

```text
pod 'Gleap', '>= 16.4.0'
```

```text
pod install
```

--------------------------------

### Install Gleap SDK via npm/yarn

Source: https://docs.gleap.io/documentation/javascript/README

Install the Gleap package using npm or yarn. Then, initialize the SDK in your JavaScript code.

```bash
npm install gleap --save
```

```javascript
import Gleap from "gleap";

// Please make sure to call this method only once!
Gleap.initialize("API_KEY");
```

--------------------------------

### Response example

Source: https://docs.gleap.io/api-reference/session/search-for-sessions

Example of a successful 200 response.

```json
[
  "<unknown>"
]
```

--------------------------------

### Web Installation Snippet

Source: https://docs.gleap.io/documentation/flutter/README

Insert this JavaScript snippet into the head tag of your index.html file for web integration. Ensure you run 'flutter clean' and 'flutter pub get' afterwards.

```html
<script>
!function(){if(!(window.Gleap=window.Gleap||[]).invoked){window.GleapActions=[];var e=new Proxy({invoked:!0},{get:function(e,n){return"invoked"===n?e.invoked:function(){var e=Array.prototype.slice.call(arguments);window.GleapActions.push({e:n,a:e})}},set:function(e,n,t){return e[n]=t,!0}});window.Gleap=e;var n=document.getElementsByTagName("head")[0],t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://sdk.gleap.io/latest/index.js",n.appendChild(t)}}
();
</script>
```

--------------------------------

### Open the Gleap Widget

Source: https://docs.gleap.io/documentation/cordova/widget-control

Call this method to display the Gleap widget to the user. No specific setup is required beyond plugin installation.

```javascript
cordova.plugins.GleapPlugin.open();
```

--------------------------------

### Install Gleap SDK for Capacitor v5

Source: https://docs.gleap.io/documentation/ioniccapacitor/README

Install the Gleap package using npm for Capacitor v5. Sync your Capacitor dependencies afterwards.

```bash
npm install capacitor-gleap-plugin
```

```bash
npx cap sync
```

--------------------------------

### Install Gleap SDK for Capacitor v3

Source: https://docs.gleap.io/documentation/ioniccapacitor/README

Install the Gleap SDK package for Capacitor v3 using npm. Sync your Capacitor dependencies afterwards.

```bash
npm install capacitor-gleap-plugin@8.2.3
```

```bash
npx cap sync
```

--------------------------------

### Install Gleap SDK for Capacitor v4

Source: https://docs.gleap.io/documentation/ioniccapacitor/README

Install the Gleap SDK package for Capacitor v4 using npm. Sync your Capacitor dependencies afterwards.

```bash
npm install GleapSDK/Capacitor-SDK#capacitor-v4 --save
```

```bash
npx cap sync
```

--------------------------------

### Start a Product Tour via URL Parameters

Source: https://docs.gleap.io/documentation/javascript/producttours

Launch a product tour by including specific parameters in the URL. This is ideal for sending direct links to users to start a particular tour with a defined delay.

```url
https://yourapp.com/?gleap_tour={your-product-tour-id}&gleap_tour_delay={delay_in_seconds}
```

--------------------------------

### Perform GET Request with cURL

Source: https://docs.gleap.io/documentation/server/api-overview

Example of a GET request to the tickets endpoint using cURL.

```bash
curl -X GET https://api.gleap.io/v3/tickets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Project: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json"
```

--------------------------------

### Install Gleap SDK via NuGet

Source: https://docs.gleap.io/documentation/windowsdesktop/README

Use the .NET CLI to add the pre-release Gleap.WebView2 package to your project.

```bash
dotnet add package Gleap.WebView2 --prerelease
```

--------------------------------

### GET /v3/tickets/{ticketId}/history

Source: https://docs.gleap.io/documentation/server/api-samples

Retrieves the history of changes for a specific ticket. Entries are returned in chronological order, starting from the oldest.

```APIDOC
## GET /v3/tickets/{ticketId}/history

### Description
Retrieves the history of changes for a specific ticket, including status, assignee, team, priority, type, tags, title, and due date updates.

### Method
GET

### Endpoint
/v3/tickets/{ticketId}/history

### Parameters
#### Path Parameters
- **ticketId** (string) - Required - The unique identifier of the ticket.

### Response
#### Success Response (200)
- **items** (array) - List of history entries.
- **truncated** (boolean) - Indicates if there are more entries than the limit.

#### Response Example
{
  "items": [
    {
      "id": "689b1f77bcf86cd799439031",
      "ticket": "507f1f77bcf86cd799439022",
      "type": "FEEDBACK_UPDATED",
      "data": {
        "type": "STATUS",
        "value": "INPROGRESS"
      },
      "user": {
        "id": "507f1f77bcf86cd799439012",
        "email": "support@example.com",
        "firstName": "John",
        "lastName": "Doe"
      },
      "bot": false,
      "createdAt": "2026-08-07T10:30:00.000Z",
      "ticketHistoryRow": true
    }
  ],
  "truncated": false
}
```

--------------------------------

### Detailed HttpUrlConnection Logging Example

Source: https://docs.gleap.io/documentation/android/network-logs

A comprehensive example demonstrating how to set up and log a POST request using HttpUrlConnection, including request body creation and response reading.

```java
....
  @Override
    protected Object doInBackground(Object[] objects) {
        HttpURLConnection conn = null;
        JSONObject result = null;
        try {
            URL url = new URL("YOUR_URL");
            conn = (HttpURLConnection) url.openConnection();
            conn.setRequestProperty("Accept", "application/json");
            conn.setRequestProperty("Content-Type", "application/json");
            conn.setRequestMethod("POST");

            JSONObject requestBody = new JSONObject();
            try {
                requestBody.put("Key", "Value");
                requestBody.put("Key2", "Value");
            } catch (JSONException e) {
                e.printStackTrace();
            }


            try (OutputStream os = conn.getOutputStream()) {
                byte[] input = requestBody.toString().getBytes(StandardCharsets.UTF_8);
                os.write(input, 0, input.length);
            }

            try (BufferedReader br = new BufferedReader(
                    new InputStreamReader(conn.getInputStream(), "utf-8"))) {

                String input;
                while ((input = br.readLine()) != null) {
                    result = new JSONObject(input);
                }
            } catch (JSONException e) {
                e.printStackTrace();
            }
            Gleap.getInstance().logNetwork((HttpsURLConnection) conn, requestBody, result);
        } catch(Exception e) {
            e.printStackTrace();
        }
```

--------------------------------

### Search for sessions API requests

Source: https://docs.gleap.io/api-reference/session/search-for-sessions

Examples of how to perform a GET request to the sessions search endpoint across various programming languages.

```curl
curl --request GET \
  --url https://api.gleap.io/v3/sessions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
```

```python
import requests

url = "https://api.gleap.io/v3/sessions/search"

headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {
  method: 'GET',
  headers: {project: '<project>', Authorization: 'Bearer <token>'}
};

fetch('https://api.gleap.io/v3/sessions/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/sessions/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/sessions/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.gleap.io/v3/sessions/search")
  .header("project", "<project>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/sessions/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Install Gleap SDK via Script Tag

Source: https://docs.gleap.io/documentation/javascript/README

Add this snippet to the <head> of your HTML to load the Gleap widget asynchronously. Replace 'API_KEY' with your actual API key.

```html
<script>
!function(){if(!(window.Gleap=window.Gleap||[]).invoked){window.GleapActions=[];const e=new Proxy({invoked:!0},{get:function(e,n){return"invoked"===n?e.invoked:function(){const e=Array.prototype.slice.call(arguments);window.GleapActions.push({e:n,a:e})}},set:function(e,n,t){return e[n]=t,!0}});window.Gleap=e;const n=document.getElementsByTagName("head")[0],t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://sdk.gleap.io/latest/index.js",n.appendChild(t),
        window.Gleap.initialize("API_KEY")
    }}
();
</script>
```

--------------------------------

### Start Various Gleap Content via Links

Source: https://docs.gleap.io/documentation/javascript/checklists

Demonstrates the URI scheme format for triggering different types of Gleap content.

```html
<a href="gleap://tour/PRODUCT_TOUR_ID">Start product tour</a>
<a href="gleap://survey/SURVEY_ID">Open survey</a>
<a href="gleap://article/ARTICLE_ID">Open help article</a>
<a href="gleap://news/NEWS_ID">Open news article</a>
```

--------------------------------

### Alamofire Example Usage

Source: https://docs.gleap.io/documentation/ios/network-logs

Shows how to use the custom GleapSessionManager to make network requests, which will then be logged by the Gleap SDK.

```swift
GleapSessionManager.sharedManager.request("https://www.sample.org/get").response { response in
    debugPrint(response)
}
```

--------------------------------

### Initialize Gleap SDK

Source: https://docs.gleap.io/documentation/reactnative/README

Initialize the SDK in your index.js file using your API token. Ensure this is executed only once.

```javascript
Gleap.initialize("Your_TOKEN");
```

--------------------------------

### Start a new conversation in C#

Source: https://docs.gleap.io/documentation/maui/conversations

Manually trigger the start of a new conversation interface.

```csharp
Gleap.StartConversation(showBackButton: true);
```

--------------------------------

### Gleap.OpenHelpCenter

Source: https://docs.gleap.io/documentation/maui/helpcenter

Opens the help center within the Gleap widget.

```APIDOC
## Gleap.OpenHelpCenter(showBackButton: bool)

### Description
Opens the help center directly within the Gleap widget.

### Parameters
- **showBackButton** (bool) - Optional - Determines if the back button is displayed in the widget.
```

--------------------------------

### GET /helpcenter/collections/stats

Source: https://docs.gleap.io/api-reference/help-center-collections/get-article-stats

Get live/draft article counts across the whole help center.

```APIDOC
## GET /helpcenter/collections/stats

### Description
Get live/draft article counts across the whole help center.

### Method
GET

### Endpoint
https://api.gleap.io/v3/helpcenter/collections/stats

### Parameters
#### Header Parameters
- **project** (string) - Required - The project identifier.

### Response
#### Success Response (200)
- **draftArticlesCount** (number) - The count of draft articles.
- **liveArticlesCount** (number) - The count of live articles.
```

--------------------------------

### Install Gleap MAUI Package

Source: https://docs.gleap.io/documentation/maui/README

Use the .NET CLI to add the pre-release Gleap MAUI package to your project.

```bash
dotnet add package Gleap.Maui --prerelease
```

--------------------------------

### OpenAPI definition for Get a company

Source: https://docs.gleap.io/api-reference/company/get-a-company

The OpenAPI specification for the GET request to retrieve a company by its external companyId.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /companies/{companyId}:
    get:
      tags:
        - Company
      summary: Get a company
      description: >-
        Get one company by its external `companyId`, the identifier your app
        sends via the SDK, not the
```

--------------------------------

### Start a Product Tour Programmatically

Source: https://docs.gleap.io/documentation/javascript/producttours

Initiate a product tour using the Gleap API. This method is useful for starting tours based on specific user interactions or application states.

```javascript
Gleap.startProductTour("PRODUCT_TOUR_ID");
```

--------------------------------

### Start Custom Form

Source: https://docs.gleap.io/documentation/ios/feedback-flows

Initiates a custom form using a specified key. This is useful when default forms do not meet specific use case requirements. The `showBackButton` option is configurable.

```javascript
Gleap.startClassicForm("CUSTOM_FORM_KEY", showBackButton: true);
```

--------------------------------

### GetMessages Response Example

Source: https://docs.gleap.io/api-reference/messages/find-messages-by-query

Example JSON response structure for the GetMessages operation, showing an array of message objects.

```json
[
  {
    "id": "507f1f77bcf86cd799439015",
    "ticket": "507f1f77bcf86cd799439011",
    "type": "TEXT",
    "data": {
      "content": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "This is a sample message content."
              }
            ]
          }
        ]
      }
    },
    "comment": "This is a sample message content.",
    "bot": false,
    "user": {
      "id": "507f1f77bcf86cd799439012",
      "email": "support@example.com",
      "firstName": "John",
      "lastName": "Doe"
    },
    "session": {
      "_id": "507f1f77bcf86cd799439013",
      "id": "507f1f77bcf86cd799439013",
      "email": "user@example.com"
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "index": 0
  },
  {
    "id": "507f1f77bcf86cd799439016",
    "ticket": "507f1f77bcf86cd799439011",
    "type": "TEXT",
    "data": {
      "content": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Thank you for the update!"
              }
            ]
          }
        ]
      }
    },
    "comment": "Thank you for the update!",
    "bot": false,
    "user": {
      "id": "507f1f77bcf86cd799439017",
      "email": "user@example.com",
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "session": {
      "_id": "507f1f77bcf86cd799439013",
      "id": "507f1f77bcf86cd799439013",
      "email": "user@example.com"
    },
    "createdAt": "2024-01-15T11:00:00.000Z",
    "updatedAt": "2024-01-15T11:00:00.000Z",
    "index": 1
  }
]
```

--------------------------------

### Start Custom Form

Source: https://docs.gleap.io/documentation/cordova/feedback-flows

Initiates a custom form using a specified key. Ensure the custom form is configured in the Gleap dashboard.

```javascript
cordova.plugins.GleapPlugin.startClassicForm("CUSTOM_FORM_KEY");
```

--------------------------------

### OpenAPI definition for Get all articles

Source: https://docs.gleap.io/api-reference/help-center-articles/get-all-articles

The OpenAPI specification defining the GET request for retrieving help center articles.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /helpcenter/collections/{helpcenterCollectionId}/articles:
    get:
      tags:
        - Help center articles
      summary: Get all articles
      description: >-
        Get every article in a help center collection, published and
        unpublished, sorted by `lexorank`. This

        endpoint is not paginated.
      operationId: GetHelpcenterArticles
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/HelpcenterArticleDocument'
                type: array
      security:
        - jwt: []
components:
  schemas:
    HelpcenterArticleDocument:
      allOf:
        - $ref: '#/components/schemas/HelpcenterArticleI'
        - $ref: '#/components/schemas/Document'
    HelpcenterArticleI:
      $ref: '#/components/schemas/InferSchemaType_typeofhelpcenterArticleSchema_'
    Document:
      $ref: '#/components/schemas/FlattenMaps_T_'
      description: >-
        Generic types for Document:

        *  T - the type of _id

        *  TQueryHelpers - Object with any helpers that should be mixed into the
        Query type

        *  DocType - the type of the actual Document created
    InferSchemaType_typeofhelpcenterArticleSchema_:
      $ref: >-
        #/components/schemas/IfAny_typeofhelpcenterArticleSchema.any.ObtainSchemaGeneric_typeofhelpcenterArticleSchema.DocType__
    FlattenMaps_T_:
      properties: {}
      type: object
    IfAny_typeofhelpcenterArticleSchema.any.ObtainSchemaGeneric_typeofhelpcenterArticleSchema.DocType__:
      allOf:
        - properties:
            updatedAt:
              $ref: '#/components/schemas/NativeDate'
            createdAt:
              $ref: '#/components/schemas/NativeDate'
          required:
            - updatedAt
            - createdAt
          type: object
        - properties:
            extendedAudienceFilter: {}
            baseAudienceFilter: {}
            docId:
              type: number
              format: double
            author:
              properties:
                isValid:
                  properties: {}
                  type: object
                createFromHexString:
                  properties: {}
                  type: object
                createFromTime:
                  properties: {}
                  type: object
                generate:
                  properties: {}
                  type: object
                cacheHexString: {}
              type: object
            helpcenterCollection:
              properties:
                isValid:
                  properties: {}
                  type: object
                createFromHexString:
                  properties: {}
                  type: object
                createFromTime:
                  properties: {}
                  type: object
                generate:
                  properties: {}
                  type: object
                cacheHexString: {}
              type: object
            upvotes: {}
            plainContent: {}
            lexorank:
              type: string
            project:
              properties:
                isValid:
                  properties: {}
                  type: object
                createFromHexString:
                  properties: {}
                  type: object
                createFromTime:
                  properties: {}
                  type: object
                generate:
                  properties: {}
                  type: object
                cacheHexString: {}
              type: object
            externalId:
              type: string
            content: {}
            title: {}
            description: {}
            sourceUsage:
              type: number
              format: double
            version:
              type: number
              format: double
            isDraft:
              type: boolean
            targetAudience:
              type: string
            tags:
              items:
                type: string
              type: array
          required:
            - sourceUsage
            - version
            - isDraft
            - targetAudience
            - tags
          type: object
    NativeDate:
      type: string
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### OpenAPI definition for Get all banners

Source: https://docs.gleap.io/api-reference/engagement-banner/get-all-banners

Defines the GET /engagement/banners endpoint, including required headers and security schemes.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/banners:
    get:
      tags:
        - Engagement Banner
      summary: Get all banners
      description: >-
        Get the engagement banners of a project, newest first. Supports
        filtering by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetBanners
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### AFNetworking Example Usage

Source: https://docs.gleap.io/documentation/ios/network-logs

Demonstrates how to use the custom GleapAFURLSessionManager to make network requests and have them logged by Gleap.

```objectivec
// Use the GleapAFURLSessionManager for all further requests
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
GleapAFURLSessionManager *manager = [[GleapAFURLSessionManager alloc] initWithSessionConfiguration: configuration];

[manager GET: @"https://www.example.org/get" parameters:nil headers:nil progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id  _Nullable responseObject) {
        NSLog(@"JSON: %@", responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
        NSLog(@"Error: %@", error);
}];
```

--------------------------------

### Initialize Gleap SDK

Source: https://docs.gleap.io/documentation/maui/README

Attach the Gleap SDK to a WebView channel and initialize the session using your SDK key.

```csharp
using GleapSDK;
using GleapSDK.Maui;

// `channel` bridges the platform WebView (see the platform notes below).
await GleapMaui.AttachAsync(channel, "YOUR_SDK_KEY");
Gleap.Open();
```

--------------------------------

### Start a New Conversation

Source: https://docs.gleap.io/documentation/android/conversations

Manually initiate a new conversation. Call this method to programmatically start a new chat session.

```javascript
Gleap.getInstance().startConversation(true);
```

--------------------------------

### Add Gleap Unity Package

Source: https://docs.gleap.io/documentation/unity/README

Use the Unity Package Manager to install the SDK via Git URL.

```text
https://github.com/GleapSDK/CSharp-SDK.git?path=/unity/com.gleap.sdk#v0.1.0-beta.1
```

--------------------------------

### OpenAPI definition for Get all sessions

Source: https://docs.gleap.io/api-reference/session/get-all-sessions

The OpenAPI specification for the GET /sessions endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /sessions:
    get:
      tags:
        - Session
      summary: Get all sessions
      description: >-
        List sessions (contacts) of the project. Paginated: `limit` defaults to
        50 and is capped at 100 per page,

        and paging cannot go past the first 10,000 results. Optional query
        parameters: `type` (`users` = has

        userId, `guests` = no userId, `unsubscribed`, or `organisations`; the
        latter returns aggregated

        organisations instead of sessions), `companyId` (only sessions of this
        company), `withFeedback` (only

        sessions with at least one ticket), `contactViewId` (returns the
        sessions matching a saved contact view;

        404 when the view does not exist), plus `skip` and `sort`.
      operationId: GetSessions
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                items: {}
                type: array
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### OpenAPI definition for Get all users

Source: https://docs.gleap.io/api-reference/project/get-all-users-for-a-project

The OpenAPI specification for the GET /projects/users endpoint, including required headers and security schemes.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /projects/users:
    get:
      tags:
        - Project
      summary: Get all users for a project
      description: >-
        Get everyone who can access this project: direct project members plus
        all members of its organisation.

        Each entry carries `type` (`project` or `organisation`) and `role`.
        Service accounts are excluded.
      operationId: GetUsers
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                items: {}
                type: array
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Open Checklists Overview

Source: https://docs.gleap.io/documentation/android/checklists

Use this method to display the checklists overview to the user. Ensure the Gleap SDK is initialized.

```javascript
Gleap.getInstance().openChecklists(true);
```

--------------------------------

### Initialize Gleap SDK

Source: https://docs.gleap.io/documentation/ios/README

Initialize the SDK using your API token within the application delegate or main app class.

```swift
Gleap.initialize(withToken: "API-TOKEN")
```

```objectivec
[Gleap initializeWithToken: @"API-TOKEN"];
```

--------------------------------

### Get an article draft OpenAPI definition

Source: https://docs.gleap.io/api-reference/help-center-articles/get-an-article-draft

The OpenAPI specification for the GET request to retrieve a help center article draft.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}/draft:
    get:
      tags:
        - Help center articles
      summary: Get an article draft
      description: Get the staged (unpublished) draft of a help center article, or null
      operationId: GetHelpcenterArticleDraft
      parameters:
        - in: path
          name: helpcenterArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Get all tooltips OpenAPI definition

Source: https://docs.gleap.io/api-reference/engagement-tooltip/get-all-tooltips

OpenAPI specification for the GET /engagement/tooltips endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/tooltips:
    get:
      tags:
        - Engagement Tooltip
      summary: Get all tooltips
      description: >-
        Get the engagement tooltips of a project, newest first. Supports
        filtering by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetTooltips
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Initialize the SDK

Source: https://docs.gleap.io/documentation/server/nodejs

Initialize the SDK using your secret API token before performing any operations.

```js
GleapAdmin.initialize(process.env.GLEAP_API_TOKEN);
```

--------------------------------

### Open the help center via C#

Source: https://docs.gleap.io/documentation/maui/helpcenter

Displays the main help center interface within the Gleap widget.

```csharp
Gleap.OpenHelpCenter(showBackButton: true);
```

--------------------------------

### OpenAPI definition for Get all surveys

Source: https://docs.gleap.io/api-reference/engagement-survey/get-all-surveys

The OpenAPI specification for the GET /engagement/surveys endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/surveys:
    get:
      tags:
        - Engagement Survey
      summary: Get all surveys
      description: >-
        Get the engagement surveys of a project, newest first. Supports
        filtering by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetSurveys
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### OpenAPI definition for Get all modals

Source: https://docs.gleap.io/api-reference/engagement-modal/get-all-modals

The OpenAPI specification for the GET /engagement/modals endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/modals:
    get:
      tags:
        - Engagement Modal
      summary: Get all modals
      description: >-
        Get the engagement modals of a project, newest first. Supports filtering
        by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetModals
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Start Checklist via Link

Source: https://docs.gleap.io/documentation/javascript/checklists

Initiates a checklist using a custom URI scheme, which can be used in standard HTML links.

```html
<a href="gleap://checklist/OUTBOUND_ID">Start checklist</a>
```

--------------------------------

### OpenAPI definition for Get all emails

Source: https://docs.gleap.io/api-reference/engagement-email/get-all-emails

The OpenAPI specification for the GET /engagement/emails endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/emails:
    get:
      tags:
        - Engagement Email
      summary: Get all emails
      description: >-
        Get the engagement emails of a project, newest first. Supports filtering
        by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetEngagementEmails
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Start Network Recording (Swift)

Source: https://docs.gleap.io/documentation/ios/network-logs

Call this function to begin recording all network requests. Ensure it's called before any network activity you wish to log.

```swift
Gleap.startNetworkRecording();
```

--------------------------------

### Gleap.StartChecklist

Source: https://docs.gleap.io/documentation/maui/checklists

Manually triggers a specific checklist for the user.

```APIDOC
## Gleap.StartChecklist

### Description
Manually starts a checklist using its outbound ID.

### Parameters
- **outboundId** (string) - Required - The outbound ID found within the checklist editor.
- **showBackButton** (bool) - Optional - Whether to display a back button in the widget header.
```

--------------------------------

### OpenAPI definition for Get all checklists

Source: https://docs.gleap.io/api-reference/engagement-checklist/get-all-checklists

The OpenAPI specification for the GET /engagement/checklists endpoint, including security requirements and parameter definitions.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/checklists:
    get:
      tags:
        - Engagement Checklist
      summary: Get all checklists
      description: >-
        Get the engagement checklists of a project, newest first. Supports
        filtering by any field via query

        parameters, plus `skip`, `limit` and `sort` (e.g. `sort=-createdAt`).
        `limit` defaults to 1000 when

        omitted; when supplied, values above 100 are clamped to 100. Filtering
        by `project` or `organisation`

        is rejected.
      operationId: GetChecklists
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Open Checklists Overview

Source: https://docs.gleap.io/documentation/ios/checklists

Use this Objective-C method to display the checklists overview to the user. Ensure the Gleap SDK is initialized.

```objective-c
[Gleap openChecklists];
```

--------------------------------

### GET /engagements/{engagementId}/statistics

Source: https://docs.gleap.io/api-reference/engagement/get-engagement-statistics

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

```APIDOC
## GET /engagements/{engagementId}/statistics

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

### Method
GET

### Endpoint
https://api.gleap.io/v3/engagements/{engagementId}/statistics

### Parameters
#### Path Parameters
- **engagementId** (string) - Required - The unique identifier of the engagement.

#### Header Parameters
- **project** (string) - Required - The project identifier.

### Response
#### Success Response (200)
- **body** (object) - Returns the engagement statistics object.
```

--------------------------------

### GET /companies

Source: https://docs.gleap.io/api-reference/company/list-companies

Retrieves a list of companies. Note that this returns a summary; use GET /companies/{companyId} for the full record.

```APIDOC
## GET /companies

### Description
Retrieves a list of companies associated with the project. This endpoint returns a summary of company records.

### Method
GET

### Endpoint
/companies

### Parameters
#### Header Parameters
- **project** (string) - Required - The project identifier.

### Response
#### Success Response (200)
- **items** (array) - A list of company objects containing summary information such as companyId, name, domain, and customData.
```

--------------------------------

### Start Network Recording (Objective-C)

Source: https://docs.gleap.io/documentation/ios/network-logs

Use this Objective-C method to initiate network request recording. It's essential to call this before making network calls.

```objectivec
[Gleap startNetworkRecording];
```

--------------------------------

### Start Custom Form

Source: https://docs.gleap.io/documentation/android/feedback-flows

Initiates a custom form using a provided key. The first parameter is the custom form key, and the second controls the visibility of the back button.

```javascript
Gleap.getInstance().startClassicForm("CUSTOM_FORM_KEY", true);
```

--------------------------------

### OpenAPI Specification for Get All Tickets

Source: https://docs.gleap.io/api-reference/ticket/get-all-tickets

The OpenAPI definition for the GET /tickets endpoint, including request parameters and a sample response structure.

```yaml
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /tickets:
    get:
      tags:
        - Ticket
      summary: Get all tickets
      description: >-
        Get all tickets in a project with support for filtering, sorting, and
        pagination.


        **Filtering:**

        - Filter by type: `type=BUG` or `type=BUG,FEATURE_REQUEST`

        - Filter by status: `status=OPEN`

        - Filter by priority: `priority=HIGH` or `priority=HIGH,MEDIUM`

        - Filter by archived state: archived tickets are hidden by default; pass
        `ignoreArchived=true` to include them,
          or `ignoreArchived=true&archived=true` for archived tickets only
        - Filter by spam: `isSpam=false`

        - Filter the archive by archive date: `startDate` / `endDate` (ISO 8601)
        narrow the archive, spam and
          waiting-on-customer views to tickets archived within that range. Ignored on the non-archive views,
          where `archivedAt` is unset.

        **Sorting:**

        - Sort by creation date: `sort=-createdAt` (newest first) or
        `sort=createdAt` (oldest first)

        - Sort by priority: `sort=priority` (highest first: HIGH, MEDIUM, LOW)
        or `sort=-priority` (lowest first)

        - Sort by updated date: `sort=-updatedAt`

        - Default sort (no `sort` param): most recent activity first
        (`lastNotification` descending)

        - Archived, spam and waiting-on-customer views always sort by
        `archivedAt` descending; a `sort` param is ignored there


        **Pagination:**

        - Limit results: `limit=20` (default: 500, max: 500)

        - Skip results: `skip=0` (for pagination: `skip=(page-1)*limit`)
      operationId: GetTickets
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
              examples:
                Example 1:
                  value:
                    tickets:
                      - _id: 507f1f77bcf86cd799439011
                        id: 507f1f77bcf86cd799439011
                        title: Login button not working
                        formData:
                          description: Users cannot log in when clicking the login button
                        type: BUG
                        status: OPEN
                        priority: HIGH
                        createdAt: '2024-01-15T10:30:00.000Z'
                        updatedAt: '2024-01-15T11:45:00.000Z'
                        processingUser:
                          _id: 507f1f77bcf86cd799439012
                          email: support@example.com
                          firstName: John
                          lastName: Doe
                        session:
                          _id: 507f1f77bcf86cd799439013
                          email: user@example.com
                        latestComment:
                          _id: 507f1f77bcf86cd799439014
                          data:
                            content: Any update on this issue?
                    count: 1
                    totalCount: 42
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
```

--------------------------------

### Gleap.startConversation(showBackButton?)

Source: https://docs.gleap.io/documentation/javascript/conversations

Starts a new conversation in the widget.

```APIDOC
## Gleap.startConversation(showBackButton?)

### Description
Starts a new conversation in the widget.

### Parameters
- **showBackButton** (boolean) - Optional - Controls whether the widget shows a back arrow (default: true).
```
Tokens:
Raw