Skip to main content
GET
/
users
/
search
Search for users
curl --request GET \
  --url https://open.beatpass.ca/api/v1/users/search \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "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
required

Search query

Example:

"john"

limit
integer

Maximum number of results

Example:

10

Response

Search results

status
string
Example:

"success"

users
object[]
Last modified on November 29, 2025