---
title: "API: endpoint reference — Documentation | WordPane Cloud"
url: "https://wordpane.cloud/en/documentacao/api-referencia/"
description: "Endpoints, permissions, limits and responses for API v1."
language: "en"
generatedAt: "2026-10-31T14:05:07.042Z"
contentType: "public-page"
pricingSource: "https://app.wordpane.cloud/api/public/plan-catalog"
---

[Documentation center](https://wordpane.cloud/en/documentacao/)

API and integrations

# API: endpoint reference

Endpoints, permissions, limits and responses for API v1.

**Customer area technical documentation**

Examples use fictional data and do not execute requests on this page. Never enter your real credential here.

## Explore available endpoints

Base URL: https://app.wordpane.cloud/api/v1. The table below is generated from the published OpenAPI specification. Paths are relative to the base URL. Open the current contract for each operation’s parameters and schemas.

[Open current OpenAPI 3.1](https://app.wordpane.cloud/api/v1/openapi.json)

| Method and path | Operation | Permissions |
| --- | --- | --- |
| `GET /servers` | List servers | `servers.read` |
| `GET /email-domains` | List domains | `emails.read` |
| `GET /mailboxes` | List mailboxes | `emails.read` |
| `GET /tickets` | List tickets | `tickets.read` |
| `GET /servers/{id}` | Server details | `servers.read` |
| `GET /servers/{id}/installation` | Recorded installation state | `servers.read` |
| `GET /email-domains/{id}/mailboxes` | Domain mailboxes | `emails.read` |
| `GET /tickets/{id}` | Ticket details | `tickets.read` |
| `GET /tickets/{id}/messages` | Ticket messages | `tickets.read` |
| `POST /tickets/{id}/messages` | Reply to a ticket without duplicates | `tickets.read`    `tickets.reply` |
| `GET /balance` | Entire account balance in BRL | `billing.read` |
| `GET /ledger` | Entire account ledger | `billing.read` |

## Handle errors and limits

The limit is 60 requests per minute per credential, in addition to the global source limit. On 429, respect Retry-After. For temporary failures, use increasing delays. X-Request-Id identifies the request for support; do not send your credential when asking for help.

### Permissions and details

**`401`**: Invalid, expired or revoked credential.

**`403`**: Insufficient permissions or unavailable actor access.

**`404`**: Resource missing or outside the authorized scope.

**`409`**: Idempotency conflict or closed ticket.

**`422`**: Invalid parameters; check the errors field.

**`429`**: Limit reached; wait before retrying.

**`500`**: Temporary failure; give support the X-Request-Id.

## Understand the version scope

API v1 supports queries and specifically authorized ticket replies. It does not allow purchasing, resource deletion, payments, SSH access or obtaining server passwords. Installation is a query of recorded state, not a live metrics stream. Use OpenAPI as the current contract.

Updated on October 17, 2026.

[Consult other guides](https://wordpane.cloud/en/documentacao/)

---
Fonte oficial: https://wordpane.cloud/en/documentacao/api-referencia/
Esta é uma representação da página pública. A data de geração não indica alteração editorial.