This endpoint is only to be used when a user wants to login

POST/api/auth/login

Request body

requiredapplication/json

emailstringrequired

passwordstringrequired

Responses

200OK

any

400Bad Request — message is one of: 'Invalid email and or password' | 'Please verify your email before logging in' (account not yet verified) | 'Your account has been suspended' (suspended account).

any

500Internal Server Error

any

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Bodyapplication/json

emailstring*passwordstring*

Request

curl -X POST "http://localhost:8000/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string",
  "password": "string"
}'

const response = await fetch("http://localhost:8000/api/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"string\",\n  \"password\": \"string\"\n}"
});

Response

{
  "message": "You are logged-in successfully",
  "data": {
    "user": {
      "id": "CRa7Bk9x2Q",
      "fullName": null,
      "email": "example@mail.com",
      "role": "CONTENT_CREATOR",
      "accountStatus": "VERIFIED",
      "imageUrl": null
    },
    "token": {
      "accessToken": "**********",
      "refreshToken": "**********"
    }
  }
}

{
  "message": "Please verify your email before logging in",
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Something went wrong",
  "error": "Internal Server Error",
  "statusCode": 500
}