Organizations

Organizations are top-level entities that contain collections and tracks. Manage organization settings, themes, and player configurations.

GET /v1/organization/:organization_id

Returns details about a specific organization

Parameters

Name Type Required Description
organization_id uuid Required The ID of the organization to retrieve (path parameter)

Response

{
  "ok": true,
  "api_request_id": "string",
  "organization_id": "string",
  "organization": {
    // Organization details
  }
}
PUT /v1/organization/:organization_id

Updates an existing organization

Parameters

Name Type Required Description
organization_id uuid Required The ID of the organization to update (path parameter)
name string Optional Name of the organization
theme array of strings Optional Theme settings for the organization. Array of hex color values
is_theme_overridable boolean Optional Whether organization theme can be overridden
is_cover_overridable boolean Optional Whether organization cover can be overridden
player_color string Optional Player color for the organization (hex color)
player_subtitle string Optional Player subtitle for the organization

Example Request

{
  "name": "My Organization",
  "theme": ["#FF0000", "#00FF00"],
  "is_theme_overridable": true,
  "player_color": "#FF0000"
}

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "organization_id": "uuid",
  "organization": { /* Updated organization */ }
}