canonical: https://jentic.com/apis/qigu.app/qigu

# Qigu App Qigu Open API Documentation

This document describes the differents endpoints you can use with the **Company Authentification Token** (provided by Qigu Admin).<br/>If you provide a **webhook url** in Qigu Admin, our API will call yours when specific events happens. The API exposes 15 endpoints secured with bearer authentication.

## For AI agents

Programmatically returns the list of the countries, returns the list of the languages. Covers 15 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Returns the list of the countries
- Creates a new client
- Updates an existing client
- Access Qigu Open API Documentation developer tools resources via REST API

## Use cases

### Developer Tools Operations

Use the Qigu Open API Documentation to perform developer tools operations programmatically. The API provides 15 endpoints covering core functionality including returns the list of the countries, returns the list of the languages, creates a new client.

Example prompt: Call GET /countries to returns the list of the countries

### Automated countries Management

Automate countries operations by combining multiple Qigu Open API Documentation endpoints. Agents can returns the list of the languages and then creates a new client in a single workflow.

Example prompt: Call GET /languages to returns the list of the languages, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Qigu Open API Documentation endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'returns the list of the countries', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/countries` | Returns the list of the countries |
| GET | `/languages` | Returns the list of the languages |
| POST | `/companies` | Creates a new client |
| GET | `/companies` | Returns the list of your clients |
| PUT | `/companies/{id}` | Updates an existing client |
| GET | `/programs` | Returns the list of your programs |
| POST | `/journeys` | Creates a new journey |
| GET | `/journeys` | Returns the list of your distributions |

## Key resources

- **countries** — List countries
- **companies** — Manage your clients
- **files** — Upload pictures
- **journeys** — Manage your distributions
- **groups** — Manage your groups

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 55 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 56 / 100
- **View full report:** https://jentic.com/apis/qigu.app/qigu/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Qigu API by hand means setting up its bearer auth and handling company, program, and journey calls yourself. Through Jentic you install once, import the Qigu API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Qigu puts the company id in the URL path (`/companies/{id}`), so a rule can pin your agent to one company: it can update that company and nothing else. You choose the operations it may call, so creating journeys is not included unless you add it.
- **Credential handling:** Your Qigu token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list supported countries' or 'create a journey', and Jentic returns the matching Qigu operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Qigu Open API Documentation use?

The Qigu Open API Documentation uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I returns the list of the countries with the Qigu Open API Documentation?

Yes. Use the GET /countries endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Qigu Open API Documentation?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I returns the list of the countries through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'returns the list of the countries'. Jentic returns the matching Qigu Open API Documentation operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Qigu Open API Documentation have?

The Qigu Open API Documentation exposes 15 endpoints covering countries, companies, files operations.

### Can I limit what my agent is allowed to do with the Qigu API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which Qigu operations and credentials your agent may use. Since Qigu puts the company id in the URL path, such as PUT `/companies/{id}`, you can pin the agent to a single company so it updates that record and nothing else. You also pick the exact operations it may call, so creating journeys with POST /journeys stays off unless you explicitly allow it.