When we launched the Public API BETA, we told you user management was coming. It’s here. Phase 2 of the MaxGood.work Public API BETA adds a complete, Avatar-scoped user-management surface — so you can invite, read, update, and remove your Avatar’s members programmatically, straight from the systems you already run.
If your members live in a CRM, an HRIS, a learning platform, or your own product, you can now keep your Avatar’s membership in step with them automatically — no more managing the roster by hand.
What’s new in Phase 2
Like the rest of the BETA, the user-management endpoints authenticate with an Avatar API key that an Avatar Admin creates from Avatar Admin > Account in MaxGoodWeb, and they are built for server-to-server integration. Every endpoint is scoped to the Avatar that owns the key:
GET /v1beta/users— list your Avatar’s active members, paginated.POST /v1beta/users— invite a user into your Avatar.GET /v1beta/users/{user_id}— read one member’s profile and their membership in your Avatar.PUT /v1beta/users/{user_id}— update that member’s role in your Avatar (admin, coach, license expiry, notes, structured data).DELETE /v1beta/users/{user_id}— remove a user from your Avatar. It’s a soft remove: their record, and their place in any other Avatars, are untouched.
Three rules worth knowing
Members are shared across Avatars, so the user-management surface is deliberately careful about what an Avatar key can change:
- Inviting an existing MaxGood.work user never overwrites their identity. If the email already belongs to a user, we add them to your Avatar but leave their name, role, expertise, and other personal fields exactly as they were. The response tells you it was an existing user, so your integration can react accordingly.
- Updates are membership-only.
PUTchanges a member’s relationship to your Avatar — it cannot edit a person’s identity fields. That keeps one integrator from rewriting a shared user’s profile out from under everyone else. - Invites are rate-limited and capped. To protect every Avatar, invites are subject to a per-Avatar hourly limit, your Avatar type’s seat limit, and an overall safety cap. If you need to onboard a large group at once, talk to us first and we’ll help.
Full request and response details, every field, and every error code are in the interactive reference and the Stability & Use Contract at blog.maxgood.work/api-documentation-beta.
What’s still coming
We’re continuing to grow the BETA surface. Still on the roadmap:
- Newsjacking — generate timely, on-brand articles from your Avatar’s expertise.
- Public data access — read the publicly shareable content and showcase data for Avatars.
- Avatar usage & sentiment — Avatar-scoped analytics on how your members are engaging and how they feel.
A word on “BETA”
BETA is real and substantive: these endpoints run on the same production infrastructure as the rest of MaxGood.work, and every action they take is a production action. During BETA we may evolve endpoints, and we announce any breaking change at least one week ahead — on the documentation page and in our Discord. The full commitment is spelled out in the Stability & Use Contract on the docs page.
Get started
Read the docs at blog.maxgood.work/api-documentation-beta, generate an API key from your Avatar Admin account page, and join our Discord — the v1beta-api-support channel is where we read every piece of BETA feedback, and where it directly shapes what the GA API will look like.