Compteam API documentation
The Compteam REST API supports existing club and member workflows. Start with the Compteam OpenAPI specification or the interactive API reference. For AI assistants, use the Compteam MCP server.
Authentication and access
Protected REST operations require a valid Bearer access token for the intended account. The server checks the current club, role and subscription on each request. The specification describes routes; it does not grant access or issue API keys.
Connectors should use the documented MCP OAuth flow rather than collecting passwords. A 401 requires authentication; a 403 requires the appropriate permission. Retrying either response does not grant access.
Idempotency and safe retries
These POST operations accept a UUID Idempotency-Key header or the existing idempotency_key JSON field. If both are supplied they must match:
/api/v1/billing/association-settlements/api/v1/scm/purchase-orders/from-association-payable
Keep the same key and payload when retrying after a connection failure. Their existing database transactions prevent duplicate creation; conflicting reuse returns 409. The settlement response may report created: false on replay. Keys are retained with the business record. Do not assume other REST writes support this header or automatically retry an uncertain write.
MCP mutations separately use the documented request_id argument and confirmation requirements.
Rate limits and backoff
Endpoints with an enforced in-memory limiter return RateLimit-Policy, RateLimit and compatibility fields RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset. Remaining counts include the current request; reset values are seconds until capacity becomes available. A 429 includes Retry-After in seconds.
Public catalogs, server cards and OpenAPI downloads have a limit of 300 GET or HEAD requests per minute per client IP per server process on each host. The API host’s resource index and root share its download quota. Requests to robots.txt, health checks, OAuth metadata and authenticated account APIs do not consume this download quota. Other endpoint limits apply separately.
Wait at least Retry-After, then use bounded exponential backoff with jitter. These limits apply per client IP within a server process and are advisory across multiple instances. Responses without these fields do not promise an unlimited quota.
Asynchronous responses
A 202 means work was accepted, not completed. SEPA notice submission returns a Location header pointing to the protected notice-preview resource for delivery counts. Poll it with the same authorized club account; queued and uncertain counts do not prove inbox delivery. A SaaS administrator’s branch-deletion response links to its existing protected job resource.
Versions and compatibility
The current REST prefix is /api/v1. Clients should tolerate additional response fields and use the published OpenAPI schemas. No fixed support period, deprecation notice period or sunset date is currently promised. Check this reference before upgrading an integration.
Read the API versioning and deprecation policy for migration and lifecycle signals.
Developer index · Official Claude integration source · Official Gemini integration source