For external integrators: audience, reading order, capabilities, and prerequisites of the Qoder OpenAPI.
This document explains how to use the Qoder OpenAPI to query members, usage, and AI code metrics at the organization level. All endpoints require an API Key and can only access data within the organization bound to that key.
Follow the sidebar order for a step-by-step integration path:
Before calling, obtain
If an endpoint returns an error, record the
Audience
- Organization administrators or delegated integration / ops / data personnel who need to programmatically pull organizational data from external systems.
- Callers should have basic experience with HTTPS, JSON, and REST.
Suggested reading order
Follow the sidebar order for a step-by-step integration path:
- Conventions — Endpoints, authentication, pagination, error format, and field naming.
- Obtain API Key — Create a key in the console.
- API Key Security — Storage, rotation, and leak response.
- Members API — Member list, details, statistics, quotas, and management endpoints.
- Usage API — Credits usage events and aggregation; organization-level usage events.
- AI Code Metrics & Tracing — Aggregate statistics, commit attribution, and detail/export.
Capabilities (summary)
| Category | Description |
|---|---|
| Authentication | Header Authorization: Bearer <api_key>, key is bound to an organization. |
| Data scope | Only data within the key's organization is accessible; specific fields are defined per endpoint. |
| Base path | Organization endpoints are prefixed with /v1/organizations/{organization_id} (see Conventions). |
The API Key has the same resource access and operation capabilities as its creator (within the product permission model). Never commit the key to repositories, chat, or email in plaintext.
Organization ID
Before calling, obtain organization_id from the Qoder Web console organization settings or the organization URL (examples below use org_xxx as a placeholder — replace with your actual value).
Getting help
If an endpoint returns an error, record the requestId from the response body and provide it to Qoder support for troubleshooting.