Skip to main content
GET
/
search
Get information about albums, artists, playlists, tracks or users that match a keyword string.
curl --request GET \
  --url https://open.beatpass.ca/api/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "query": "led zeppelin",
  "results": {
    "artists": {
      "id": 123,
      "name": "Led Zeppelin",
      "image_small": "https://example.com/image1.jpg",
      "verified": true
    },
    "albums": {
      "id": 123,
      "name": "Coda",
      "image": "https://example.com/image1.jpg",
      "release_date": "1982-11-19",
      "description": "<string>",
      "tracks": [
        {
          "id": 123,
          "name": "Hey Hey What Can I Do",
          "release_date": "1982-11-19",
          "image": "https://example.com/image1.jpg",
          "duration": 5645848548,
          "description": "<string>",
          "artists": [
            {
              "id": 123,
              "name": "Led Zeppelin",
              "image_small": "https://example.com/image1.jpg",
              "verified": true
            }
          ]
        }
      ],
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "tracks": {
      "id": 123,
      "name": "Hey Hey What Can I Do",
      "release_date": "1982-11-19",
      "image": "https://example.com/image1.jpg",
      "duration": 5645848548,
      "description": "<string>",
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "playlists": {
      "id": 123,
      "name": "Some Playlist",
      "public": true,
      "collaborative": false,
      "image": "https://example.com/image1.jpg",
      "description": "<string>"
    },
    "users": {
      "id": 123,
      "display_name": "<string>",
      "avatar": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
query
string

Search query keywords

Example:

"led zeppelin"

​
types
string

A comma-separated list of item types to search across. Valid types are: album , artist, playlist, track, and user. Search results include hits from all the specified types.

Example:

"artist,album,track"

​
limit
integer
default:3

Maximum number of results to return. The limit is applied within each type, not on the total response.

Example:

3

Response

For each type provided in the type parameter, the response body contains an array of artist, album, track, playlist and user objects in JSON.

​
status
string
Example:

"success"

​
query
string
Example:

"led zeppelin"

​
results
object
Last modified on November 29, 2025