API Reference

Organisation

Purpose

This group contains endpoints tagged together in the OpenAPI spec. Use the summaries below to understand what each endpoint does.

When to use

Prefer calling APIs from your backend to avoid exposing secrets.
Handle errors consistently and log request IDs for support.

Endpoints (6)

Click an endpoint to jump to its details.

get/organisations

Auth

List my organisations

post/organisations

Auth

Create an organisation (merchant registers their org)

delete/organisations/{id}

Auth

Delete organisation (owner only)

get/organisations/{id}

Auth

Get one organisation (owner or admin)

patch/organisations/{id}

Auth

Update organisation (owner: name, logo; admin: maxApiKeys)

post/organisations/{id}/delete-verification

Auth

Send email verification code to delete organisation

get/organisations

List my organisations

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: OrganisationController_findAlltag: Organisationpermalink

post/organisations

Create an organisation (merchant registers their org)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: OrganisationController_createtag: Organisationpermalink

delete/organisations/{id}

Delete organisation (owner only)

Auth

Requires X-Step-Up-Token, twoFactorCode (2FA), or emailCode from POST /:id/delete-verification.

operationId: OrganisationController_removetag: Organisationpermalink

get/organisations/{id}

Get one organisation (owner or admin)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: OrganisationController_findOnetag: Organisationpermalink

patch/organisations/{id}

Update organisation (owner: name, logo; admin: maxApiKeys)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: OrganisationController_updatetag: Organisationpermalink

post/organisations/{id}/delete-verification

Send email verification code to delete organisation

Auth

Sends a 6-digit code to the organisation owner email (15 min). Use emailCode on DELETE, or use 2FA / step-up instead.

operationId: OrganisationController_requestDeleteVerificationtag: Organisationpermalink