Authentication Request
You must first issue an authentication token to view or update user information.
The issued token is valid for 1 minute and must be included in the HTTP header as X-Access-Token
for all subsequent requests.
This token keeps user accounts secure and enables safe authentication without long-lived sessions.
This API is available for Personal plans and higher.
POST
/api/user/v1/auth
{
"eml": "your@gmail.com"
}
Request Parameters
- emlstring
- Email.
Used to query or update information of users added within an organization under the Business plan or higher.
Ignored in Personal and Premium plans.
{
"code": 0,
"message": "",
"result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
Response Parameters
- codeinteger
- Response code: 0 = Success, other values = Error
- messagestring
- Response message. If the response code is not 0, an error message is returned.
- resultstring
- When requesting to view or update user information, you must include it in the HTTP header under
X-Access-Token
.
The token is valid for 1 minute and must be reissued (by calling this API again) after it expires.