canonical: https://jentic.com/apis/squidex.io/squidex

# Squidex API

squidex.io/main version 7.0.0.0. The API exposes 194 endpoints secured with openIdConnect authentication.

## For AI agents

Programmatically create a new user., get users by query.. Covers 194 operations with openIdConnect authentication.

## Scope

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

## Capabilities

- Create a new user.
- Get users by query.
- Update a user.
- Delete a User.
- Lock a user.
- Unlock a user.

## Use cases

### Developer Tools Operations

Use the Squidex API to perform developer tools operations programmatically. The API provides 194 endpoints covering core functionality including create a new user., get users by query., get a user by id..

Example prompt: Call POST `/api/user-management` to create a new user.

### Automated Apps Management

Automate apps operations by combining multiple Squidex API endpoints. Agents can get users by query. and then get a user by id. in a single workflow.

Example prompt: Call GET `/api/user-management` to get users by query., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Squidex API 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 openIdConnect tokens manually.

Example prompt: Search Jentic for 'create a new user.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/user-management` | Create a new user. |
| GET | `/api/user-management` | Get users by query. |
| GET | `/api/user-management/{id}` | Get a user by ID. |
| PUT | `/api/user-management/{id}` | Update a user. |
| DELETE | `/api/user-management/{id}` | Delete a User. |
| PUT | `/api/user-management/{id}/lock` | Lock a user. |
| PUT | `/api/user-management/{id}/unlock` | Unlock a user. |
| GET | `/api` | Get the user resources. |

## Key resources

- **Apps** — Operations for apps
- **Assets** — Operations for assets
- **Content** — Operations for content
- **Diagnostics** — Operations for diagnostics
- **Event Consumers** — Operations for event consumers

## 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:** 51 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 67 / 100
  - Developer Experience & Jentic Compatibility: 68 / 100
  - AI-Readiness & Agent Experience: 30 / 100
  - Agent Usability: 46 / 100
  - Security: 100 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/squidex.io/squidex/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 Squidex by hand means running its OpenID Connect flow against cloud.squidex.io and managing user-management calls yourself. Through Jentic you install once, import the Squidex API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Squidex puts the user id in the URL path (`/api/user-management/{id}`), so a rule can pin your agent to reading a single user. You choose the operations it may call, so ones like deleting, locking, or unlocking a user are not included unless you add them.
- **Credential handling:** Your Squidex credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list managed users' or 'look up a user by id', and Jentic returns the matching Squidex 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 Squidex API use?

The Squidex API uses openIdConnect authentication. 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 create a new user. with the Squidex API?

Yes. Use the POST `/api/user-management` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Squidex API?

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 create a new user. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new user.'. Jentic returns the matching Squidex API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Squidex API have?

The Squidex API exposes 194 endpoints covering apps, assets, content operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Squidex operations and credentials the agent may use. Squidex puts the user ID in the URL path (`/api/user-management/{id}`), so a rule can pin the agent to reading a single user through GET `/api/user-management/{id}.` You pick the operations it may call, so mutating ones like deleting, locking, or unlocking a user stay out of reach unless you add them.