{
message: 'error message'
}
{
message: 'success message'
}
The OTP for phone/email is always 1234 in dev environment
In case if user account is terminated, then it returns a field terminated: true in request body with status code 403
In case of user email is not verified, then it returns a field verificationRequired: true in request body with status code 403
Username follows the following regex:
/^[^\W_](?!.*?[._]{2})[\w.]{3,20}[^\W_]$/
/^[A-Za-z0-9\-_]{16,25}$/
200 - Success (Used in GET and PATCH API)
201 - Created Successfully (Generally used in POST API)
204 - Deleted Successfully (In this case, body would be missing)
400 - Data Validation Failed
401 - Authorization failed (Always assume you need to login again in this case)
403 - Permission denied
404 - Not found
405 - Route not implemented
409 - Already exist
410 - Gone, mostly used when things expired (i.e. links, otp, etc)
429 - Too many requests (rate limit)
500 - Server error
{
Authorization: 'Bearer <token>'
}
For every notification event, unless mentioned specifically, always assume its a firebase push notification as well as it will be saved in database
The emoji 🌍 means the API is global and don't require any token
The emoji 🔒 means the API is secure and requires users token
The emoji 🔐 means the API is secure and requires admin token
The base domain for dev environment is https://dev-vibeapp.thetunagroup.com
The base path for all users API is /api
The base path for all admin API is /api/admin
The base path for docs is always /docs