Get Live

Sounds

List the sounds on your boards

get/v1/sounds

Returns your boards from the Sounds page with the pads on them: names, pictures and pad IDs to play with POST /v1/sounds/{padId}/play. Only the sounds on your boards are listed, and never their audio. A pad can also be a voice: playing it switches to that voice. isLocked boards need a Live subscription; on a free plan only the Starter board plays.

Responses

200Your boards and their pads
  • boardsarray of SoundBoardRequired
    4 child fields
    • idstringRequired
    • namestringRequired
    • isLockedbooleanRequired

      Needs a Live subscription to play

    • padsarray of SoundPadRequired
      5 child fields
      • idstringRequired

        Pad ID for POST /v1/sounds/{padId}/play

      • namestringRequired
      • imageUrlstring or nullRequired

        The sound's picture; your own sounds may have none

      • loopbooleanRequired

        Whether it loops until played again or stopped

      • slotintegerRequired

        Its place on the board's 5 × 3 grid, row by row

401Invalid or missing API key
  • errorstringRequired

    Error message

504The desktop app did not finish the request in time
  • okbooleanRequired
  • errorstring

    Present only when ok is false