Skip to main content
GET
/
api
/
integration
curl https://api.musique.app/api/integration \
  -H "X-API-Key: msk_live_1234567890abcdef"
{
  "version": "1.0.0",
  "integration": {
    "externalId": "store_001",
    "userId": 4348,
    "permissions": [
      "audio.read",
      "audio.write",
      "audio.delete",
      "audio.send"
    ],
    "accountType": "partner",
    "createdAt": "2024-01-10T08:00:00Z"
  },
  "features": [
    "audio_upload",
    "broadcast_send",
    "scheduled_playback",
    "usage_analytics"
  ],
  "endpoints": {
    "audio": "https://api.musique.app/api/audio",
    "auth": "https://api.musique.app/api/integration/auth",
    "health": "https://api.musique.app/api/integration/health"
  }
}
Get details about the API version, your integration, and available features.
Use this endpoint to:
  • Verify your integration configuration
  • Check which features are enabled for your account
  • Confirm API version before making calls
  • Display integration status in your admin dashboard

Request

Headers

X-API-Key
string
required
Your API authentication token

Response

version
string
Current API version
integration
object
Your integration details (externalId, permissions, accountType)
features
array
List of enabled features for your account
endpoints
object
Base URLs for different API resources
curl https://api.musique.app/api/integration \
  -H "X-API-Key: msk_live_1234567890abcdef"
{
  "version": "1.0.0",
  "integration": {
    "externalId": "store_001",
    "userId": 4348,
    "permissions": [
      "audio.read",
      "audio.write",
      "audio.delete",
      "audio.send"
    ],
    "accountType": "partner",
    "createdAt": "2024-01-10T08:00:00Z"
  },
  "features": [
    "audio_upload",
    "broadcast_send",
    "scheduled_playback",
    "usage_analytics"
  ],
  "endpoints": {
    "audio": "https://api.musique.app/api/audio",
    "auth": "https://api.musique.app/api/integration/auth",
    "health": "https://api.musique.app/api/integration/health"
  }
}

Available Features

FeatureDescription
audio_uploadUpload audio files to the library
broadcast_sendSend audio to multiple locations at once
scheduled_playbackSchedule audio for future playback
usage_analyticsAccess detailed usage statistics