API: organisation, members and billing

34 endpoints. Send your API key as Authorization: Bearer <key> on each request; see The API and AI assistants for keys, errors, idempotency and the conventions every endpoint shares.

POST /api/organisation/export

Download the organisation's data as a JSON file (owners and admins)

Settings, members, invitations, API key labels, secret names, projects, phases, tasks, subtasks, issues with their events, and activity. Secret values, keys and ingest keys are never included. The current password is required again; the ten attempts per hour are shared with the personal export.

Request body (application/json, required).

Responses:

POST /api/organisation/delete-request

Start deleting the organisation (owners only); a one-hour link goes to your address

Needs the current password, the authenticator or recovery code when two-factor is on, and the organisation's name typed exactly. Refused for organisation 1 and while a Stripe subscription is active, trialing or past due (cancel it in Billing first; the app never changes Stripe). Ten attempts an hour, shared with exports and account deletion. The organisation is deleted only when the emailed link's button is used, at once and for good.

Request body (application/json, required).

Responses:

POST /api/projects/{id}/enable

Switch a project on (admins); needs room under the plan

Projects switched off because the organisation is over its plan are read-only. Switching one on needs fewer active projects than the plan allows; switch another off first, or upgrade.

Parameters:

Responses:

POST /api/projects/{id}/disable

Switch a project off (admins); it becomes read-only

Parameters:

Responses:

POST /api/members/{userId}/enable

Switch a member on (owners); needs room under the plan

Parameters:

Responses:

POST /api/members/{userId}/disable

Switch a member off (owners); they cannot use the organisation until switched on

Owners and viewers cannot be switched off. The member's sessions end; their account and work stay.

Parameters:

Responses:

GET /api/members

People in this organisation, with their roles

Responses:

PATCH /api/members/{userId}

Change a member's role (admin or owner; only owners touch ownership; the last owner stays)

Parameters:

Request body (application/json, required).

Responses:

DELETE /api/members/{userId}

Remove a member (admins), or leave (your own id); their sessions here end

Parameters:

Responses:

GET /api/invitations

Open invitations (admins)

Responses:

POST /api/invitations

Email an invitation (admins; only owners invite owners). Works once, for 7 days.

Request body (application/json, required).

Responses:

DELETE /api/invitations/{id}

Cancel an open invitation (admins)

Parameters:

Responses:

POST /auth/invitation

What an invitation token is for (organisation, email, role, inviter, whether the address has an account)

Request body (application/json, required).

Responses:

POST /auth/invitation/accept

Accept an invitation and sign in to the organisation

A new address sends name, password and over_18 true (the time of that confirmation is stored on the account; no date of birth is asked for). An existing account must be signed in as that address (401 with sign_in_required otherwise).

Request body (application/json, required).

Responses:

GET /api/api-keys

Your keys in this organisation (admins see everyone's). Never the key itself.

Responses:

POST /api/api-keys

Make a key (signed-in members; role at most yours). The key is in the response once.

Request body (application/json, required).

Responses:

DELETE /api/api-keys/{id}

Revoke a key (yours, or any for an admin)

Parameters:

Responses:

GET /api/organisation

This organisation's name, plan and settings; admins also see which secrets are set and the GitGuardian webhook address

Responses:

PATCH /api/organisation

Change settings (admins) or the name (owners). Settings merge section by section.

Request body (application/json, required).

Responses:

PUT /api/organisation/secrets/{name}

Store a secret, encrypted (admins). It is never returned.

Parameters:

Request body (application/json, required).

Responses:

DELETE /api/organisation/secrets/{name}

Remove a secret (admins)

Parameters:

Responses:

GET /api/billing

The plan, its limits, usage this month, the subscription, and every plan

Responses:

POST /api/billing/checkout

A Stripe Checkout address to subscribe to Solo or Team (owners)

Request body (application/json, required).

Responses:

POST /api/billing/portal

A Stripe customer portal address: change plan, card, invoices, cancel (owners)

Responses:

GET /api/github

Connected GitHub installations (owner, own account only; present only when the server has GITHUB_APP=on)

Responses:

POST /api/github/connect

Start connecting GitHub; returns the GitHub address to install the App from (owner only)

Responses:

POST /api/github/link

Link an installation to the organisation (owner only; single-use state from the redirect)

Request body (application/json, required).

Responses:

PATCH /api/github/installations/{id}

Set whether a merged pull request marks its tasks done (owner only)

Parameters:

Request body (application/json, required).

Responses:

DELETE /api/github/installations/{id}

Disconnect and delete the installation and every link made through it (owner only)

Parameters:

Responses:

POST /webhooks/github

GitHub's own delivery address (signature on the raw body checked first; 404 when off)

Responses:

GET /api/actions-minutes

The month's Actions minutes, for the account and each project

A repository counts towards the first project (by id) whose repo_url links it; the rest are listed in unmatched. Projects with a repository link, an allowance or usage are listed, those with an allowance or usage first.

Parameters:

Responses:

POST /api/actions-minutes/refresh

Read GitHub's usage report now

At most once a minute. A failed read keeps the last figures and sets error (the HTTP status only).

Parameters:

Responses:

GET /api/projects/{id}/actions-minutes

One project's minutes, and whether a planned build fits

fits is true only when live figures have been read this month, the project has an allowance, its used + planned is within it, and the account's used + planned + reserve is within the plan. reasons says why not. Build guards call this before a paid runner starts.

Parameters:

Responses:

PUT /api/projects/{id}/actions-allowance

Set or remove a project's monthly allowance

All the allowances together can be at most the plan less the reserve (3,000 less 100 by default); a value that would pass it is refused with how much is left. The change is in the activity log.

Parameters:

Request body (application/json, required).

Responses: