---
title: API and integration basics
description: Learn how to authenticate, use the OpenAPI browser, understand schema and class types, and work with caseworkflows and webhooks in Gluu’s REST API.
url: "https://gluu.biz/documentation/api-technical/api-and-integration-basics/"
updated: "2026-09-01"
category: API and developer tools
tags:
  - "API & Connectors"
---

# API and integration basics

*Goal: Connect Gluu to analytics, RPA and other systems via our REST API, with clear guidance on tokens, schema, class types and caseworkflow endpoints.*

You can use the API for Power BI, data analytics or integrations with RPA tools.

## Before you start

- **Plan:** The REST API and webhooks require the API & Connectors add-on. It is not included in the Core, Essential, or Advanced plan on its own.
- **Role:** You need Account Owner/Admin (**Manage account**) access to generate an API token or configure webhooks.
- **Setup:** No special setup—generate a token from Account settings once the add-on is enabled.

## Get an API token

1. Go to **[Account Settings](https://secure.gluu.biz/#/account/integrations)** > **Apps & Integration** > **API Integration**.
2. Click **Settings** to generate the authorization token. *(Account Owner/Admin required.)*
3. Store the token securely.

![API Integration settings panel for generating an authorization token](https://gluu.biz/wp-content/uploads/2025/09/image-128-1140x704.png?wsr)

Use **read-only tokens** for reads. For writes, create an **impersonated token** so changes are logged as that user.

You're done once you have a token stored securely and ready to use in your requests.

## Open API specification

Browse the API here: [api.gluu.biz/api-browser](https://api.gluu.biz/api-browser)

![Gluu API browser showing available endpoints](https://gluu.biz/wp-content/uploads/2025/09/image-129-1140x712.png?wsr)

## Schema basics

All access is over HTTPS from [https://api.gluu.biz](https://api.gluu.biz/). Requests/Responses are JSON. Timestamps are UTC, ISO 8601:

```
YYYY-MM-DDTHH:MM:SSZ
```

Entities include a class and id:

```
{
  "_class": "component",
  "_id": "custcomp-3067881d-72fd-41f4-8123-2ef1ec827f9c",
  "prop1": "..."
}
```

Reduce payloads by filtering to specific classes you need.

## Class types

`/data` queries return arrays where each object has a `_type`, e.g.:

- category
- group
- process
- activity
- form
- formversion
- formdata
- task
- caseworkflow
- user
- suggestion

## Hierarchy of class types

Understand parent/child relationships to plan queries and joins.

![Diagram showing the parent/child hierarchy of Gluu API class types](https://gluu.biz/wp-content/uploads/2025/09/image-130.png?wsr)

## Caseworkflow API overview

Caseworkflows are human-driven. You can start and track them via API and react to events with webhooks.

### Start a caseworkflow

Use this endpoint to start a caseworkflow from a template: [API: start caseworkflow](https://api.gluu.biz/api-browser#/operations/D860D6CB-B565-4F05-9FB2-1050C2DC6390).

### Webhooks

- Triggers: **Completed caseworkflow task**, **Completed scheduled task**.
- Configure under **Manage account** > **Apps and integrations** > **Webhooks**.
- Events are delivered once. `EventId` is unique. Payload contains IDs (not expanded data).
- After receiving an event, look up details, e.g. [task lookup API](https://api.gluu.biz/api-browser#/operations/query-afaa2430-f02b-4ca9-957d-f4c15d3f1c31).

### Complete a task

You can programmatically complete a task the same way as submitting it in Gluu. Submitting *form data via API is not supported*—forms should be completed by users.

## FAQ – API and integration basics

 **What plan or add-on do I need to use the Gluu API?**

The REST API and webhooks require the API & Connectors add-on. It is not included in the Core, Essential, or Advanced plan on its own.

  **Who can generate an API token?**

Only an Account Owner or Admin with Manage account access can generate the authorization token, under Account settings > Apps & Integration > API Integration.

  **What's the difference between a read-only token and an impersonated token?**

Use a read-only token for read requests. For write requests, create an impersonated token instead, so any changes the API makes are logged in Gluu as having been made by that user.

  **Can I submit form data through the API?**

No. Submitting form data via API is not supported. Forms must be completed by users directly in Gluu; the API can complete a task the same way a user submits it, but not fill in form fields.

  **How do webhooks work in Gluu?**

Webhooks fire on triggers such as a completed caseworkflow task or a completed scheduled task. Configure them under Manage account > Apps and integrations > Webhooks. Each event is delivered once with a unique EventId, and the payload contains IDs rather than expanded data—look up details with a follow-up API call.