Build on Grouperly

The Grouperly Platform API lets scripts and apps work with groups on Grouperly: their events, roster, positions, documents, photos and payments. Scoutosia is built on it.

• Base URL: https://app.grouperly.com/api/v2
• OpenAPI 3.1 document: https://app.grouperly.com/api/v2/openapi.json. It describes every endpoint, field and required scope, and the API reference here is built from it.

Three ways to call it

	Who it’s for	What it acts as
A group key (gk_…)	A group’s own scripts and integrations: a spreadsheet sync, a calendar feed	The leader who made it, in one group, with the scopes they chose
An app’s access token	Apps people sign in to with Sign in with Grouperly	The signed-in person, in the groups that installed the app
An app secret (gapp_…)	An app calling as itself, never for a group’s data	The app

Start with a group key: a group owner can make one in a minute. See the quickstart. Authentication covers all three.

Apps for other groups

Apps that other groups install and people sign in to are open to invited partners for now. If you’d like to build one, email support@grouperly.com.

The SDK

@grouperly/sdk is a typed TypeScript client generated from the OpenAPI document. @grouperly/next adds Sign in with Grouperly to a Next.js app. Both packages are on their way to npm; the quickstart shows them in use.

Stability

Version 2 only ever adds: new endpoints, fields, optional parameters, enum values and error codes. Nothing is removed or renamed within v2, and the build fails on any change that would break a client. A breaking change would be v3, and v2 would then keep working for 12 months. See Conventions.

Version 1 is frozen: it gets security fixes only. Use v2 for anything new.