Login

URLRequires AuthHTTP Method
/api/v1/loginnoPOSTPayload

ArgumentExampleRequiredDescription
usernamemyusernameRequiredYour username
passwordmy$up3erP@ssw0rdRequiredYour password
  • Notes:
    • You will need to provide the authToken and userId for any of the authenticated methods.

Example Call - As Form Data

curl http://localhost:3000/api/v1/login \
     -d "username=myusername&password=mypassword"
curl http://localhost:3000/api/v1/login \
     -d "user=myusername&password=mypassword"
curl http://localhost:3000/api/v1/login \
     -d "user=my@email.com&password=mypassword"

Example Call - As JSON

curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "username": "myusername", "password": "mypassword" }'
curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "user": "myusername", "password": "mypassword" }'
curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "user": "my@email.com", "password": "mypassword" }'

Result

{
  "status": "success",
  "data": {
      "authToken": "9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq",
      "userId": "aobEdbYhXfu5hkeqG"
   }
}