API reference

Every endpoint of the MCID HTTP API, generated from its OpenAPI document: the project API and the admin API.

Every endpoint of the MCID HTTP API, generated from the OpenAPI document the API publishes. The reference has two parts, by who calls the endpoints.

Project API

For developers of Micro Club projects: log members in, check permissions, use channels and webhooks, and send data to inbound webhooks.

30 endpoints in 7 groups. Start with the Project API overview.

Admin API

What the admin dashboard uses. These endpoints need an admin session and are not meant for projects.

88 endpoints in 15 groups. Start with the Admin API overview.

Source: apps/api/openapi.json.

Conventions: errors and rate limits

The rules shared by the whole API: the error shape, per-endpoint rate limits, CORS, paging, identifiers and times.

Project API overview

How a project calls MCID: how to authenticate and every endpoint at a glance, grouped by area.

On this page

Project APIAdmin API