Skip to main content

Login

Login to obtain a token

Description​

Login to Hexabase to obtain a token for access.

Method​

POST

Request URL Format​

/api/v0/login

Payload​

Content-Type : application/json

（Example）Login with email

{
  "email": "[email protected]",  // User's email address registered in Hexabase
  "password": "password",
  "exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // Specify the target workspace ID when logging in to a user registered as a workspace-only user.
}

（Example）Login with user_code

{
  "user_code": "sample",
  "password": "password",
  "exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // Specify the target workspace ID when logging in to a user registered as a workspace-only user.
}

Request URL Sample​

POST https://api.xxx.com/api/v0/login

Response Sample​

{
    "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}