SpedySpedy Docs

Organization

View and update your organization's settings.

The organization is the top-level tenant in Spedy. All boards, users, and data belong to an organization. Most organization settings require the settings:edit permission.

Get Current Organization

GET /api/v1/organizations/current

Returns the organization of the currently authenticated user.

Example Response

{
  "id": "org_abc123",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "logo": "https://cdn.spedy.ai/logos/acme.png",
  "createdAt": "2025-01-01T00:00:00Z"
}

Update Organization

PATCH /api/v1/organizations/current

Permission required: settings:edit

Request Body

FieldTypeRequiredDescription
namestringNoOrganization name
slugstringNoURL-friendly slug (lowercase, alphanumeric, hyphens)
logostringNoLogo URL

Example Request

{
  "name": "Acme Corporation",
  "slug": "acme-corporation"
}

Delete Organization

DELETE /api/v1/organizations/current

Permission required: settings:edit

Permanently deletes the organization and all its data. This action cannot be undone.

Request Body

FieldTypeRequiredDescription
confirmationstringYesMust match the organization name to confirm deletion