Access the interactive API docs
This guide shows you how to open the MapleGather interactive API documentation, where you can browse every endpoint, try requests, and download the OpenAPI spec to generate a client SDK.
Who can do this: Any admin (or prospective customer evaluating the API — the docs are publicly accessible without an API key).
Before you start
Section titled “Before you start”- No API key is required to browse the docs. To make authenticated API calls from the try-it panel, you’ll need a key. See Issue, scope, and manage API keys.
-
Go to Admin & Security > Integrations.
-
In the Developer section, select the Interactive docs card, or select Open ↗.
Alternatively, from the API keys page (
Admin & Security > Integrations > API keys), select API docs ↗ in the top-right of the page header. -
The docs open in a new tab. The underlying spec is served from
GET /bc/v1/openapi.jsonand rendered as a try-it interface.
What you’ll find in the docs
Section titled “What you’ll find in the docs”The interactive docs cover the full M1 API surface. Key cross-cutting behaviors documented there:
| Topic | What it covers |
|---|---|
| Idempotency | Send Idempotency-Key on every POST/PATCH; the server caches the response for 24 hours. A repeated key with a different body returns 409. |
| Rate limits | Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. A 429 response includes Retry-After. The burst tolerance is ≤200 requests over 10 seconds. |
| Pagination | All list endpoints use cursor pagination. The response nextCursor field feeds the next page’s cursor query param. Maximum limit is 100. If a cursor becomes invalid, restart from the first page (omit cursor). |
| Batch | POST /bc/v1/orgs/{orgId}/batch accepts up to 100 operations in one request and returns a per-operation result array. Batch execution is non-atomic at M1 — a failure in one operation does not roll back others. |
| Error format | All 4xx and 5xx responses are application/problem+json (Problem or ValidationProblem schema). |
Verify
Section titled “Verify”You’ll know the docs loaded when you see the endpoint list and can expand individual operations to view request/response schemas.
If something goes wrong
Section titled “If something goes wrong”- The Interactive docs link is not visible — the Developer section is hidden when API access is not enabled for your organization. Contact your organization’s owner to enable it.