Skip to main content
GET
/
users
/
{id}
Get public profile information about a user.
curl --request GET \
  --url https://open.beatpass.ca/api/v1/users/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "user": {
    "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.

Path Parameters

id
integer
required

ID of the user or "me" for currently logged in user.

Response

Response body contains a user object in JSON format.

status
string
Example:

"success"

user
object
Last modified on November 29, 2025