Skip to main content
POST
/
auth
/
login
Login and create session
curl --request POST \
  --url https://open.beatpass.ca/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "password",
  "token_name": "iphone 12"
}
'
{
  "status": "success",
  "user": {
    "id": 123,
    "display_name": "<string>",
    "avatar": "<string>"
  }
}

Body

application/json
email
string
password
string
Example:

"password"

token_name
string
Example:

"iphone 12"

Response

Operation successful

status
string
Example:

"success"

user
object
Last modified on January 23, 2026