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)

Example Request

curl -X GET "https://api.audiodelivery.net/v1/organization/ORG_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "organization_id": "uuid",
  "organization": {
    "id": "uuid",
    "name": "string",
    "image_colors": [],
    "is_theme_overridable": true,
    "is_cover_overridable": true,
    "player_color": "string",
    "player_subtitle": "string",
    "webhook_url": "string | null"
  }
}
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
image_colors array of objects Optional Colors extracted from cover images. Array of color objects with hex, area, lightness, saturation values
is_theme_overridable boolean Optional Whether organization image colors 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

curl -X PUT "https://api.audiodelivery.net/v1/organization/ORG_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Organization", "player_color": "#FF0000"}'

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "organization_id": "uuid",
  "organization": {
    "id": "uuid",
    "name": "string",
    "image_colors": [],
    "is_theme_overridable": true,
    "is_cover_overridable": true,
    "player_color": "string",
    "player_subtitle": "string",
    "webhook_url": "string | null"
  }
}