Public API
Unauthenticated endpoints for the API catalogue, OpenAPI and SDK artefacts, documentation, search, the connector directory and service status.
Updated 07/10/2026
These endpoints need no authentication and can be called from anywhere.
API catalogue
| Method | Path | Description |
|---|---|---|
GET | /api/developer-portal/public/catalogue | Published API products. Filters: q, category, status. |
GET | /api/developer-portal/public/catalogue/:slug | One product with its current version, endpoints and changelog. 404 if unknown. |
GET | /api/developer-portal/public/catalogue/:slug/openapi | The published OpenAPI document: {sourceName, importedAt, checksum, version, spec}. Optional version. |
GET | /api/developer-portal/public/catalogue/:slug/artifacts/:format | Downloads openapi, postman, typescript, python, go, csharp or java. Optional version. Sent as an attachment. |
curl "$NEXRA_API/api/developer-portal/public/catalogue?q=sandbox"
curl -OJ "$NEXRA_API/api/developer-portal/public/catalogue/integration-sandbox/artifacts/postman"Documentation and search
| Method | Path | Description |
|---|---|---|
GET | /api/developer-portal/public/docs | Published documentation pages. Optional q. |
GET | /api/developer-portal/public/docs/:slug | One published page |
GET | /api/developer-portal/public/changelog | Published changelog entries |
GET | /api/developer-portal/public/search | Ranked results across guides, error references, API operations and the changelog. q (2–120 characters), limit (1–50, default 20). |
Each search result has kind (documentation, error_reference, api_operation or changelog), title, description, href, section, and for operations method, path and version.
Connector directory
| Method | Path | Description |
|---|---|---|
GET | /api/public/connect/coverage | Counts of implemented, sandbox-validated, authorised-validated and planned providers, operations by mode and providers by category |
GET | /api/public/connect/connectors | {coverage, connectors[]} for every provider |
GET | /api/public/connect/connectors/:connectorKey | One provider. 404 if unknown. |
A connector has these fields:
identity and description: key, name, vendor, category, categoryLabel, businessAreas, industries, summary, businessValue;
status: status, implemented, validation;
provider details: authentication, documentationUrl, docs (api, auth, rateLimits, webhooks), access (plans, restrictions, sandbox), rateLimits, pagination, webhooks;
limitations;
operations[], each with key, label, description, entity, mode, approvalRequired, idempotency, pagination and incremental.
curl "$NEXRA_API/api/public/connect/connectors/xero" | jq '.operations[] | {key, mode, idempotency}'Health and status
| Method | Path | Description |
|---|---|---|
GET | /health | {status: "ok", service, timestamp} |
GET | /api/status | Overall status (operational, degraded, major_outage or maintenance), public components, open incidents with updates, and scheduled maintenance |
See also Status.