Get started now
POST

Login

https://yourdomain.com/api/v1/auth/login

Headers

KeyValueDescription
Content-Typeapplication/json

Body

FieldsTypeDescriptionRequired
emailStringEmail addresstrue
passwordStringPasswordtrue

Example

{
  "email": "email@example.com",
  "password": "password",
  "remember_me": false
}

NOTE: remember_me is currently not available, it's still working in progress, you can keep track of that feature on GitHub#8.

Response

FieldsTypeDescription
status.codeIntegerResponse code from server
status.typeStringResponse status type (success/fail)
member.member_idStringAuto-generated member unique ID
member.fist_nameStringFirst name of the member
member.last_nameStringLast name of the member
member.email_addressStringEmail address of the member
member.profile_pictureStringProfile picture of the member
member.is_ownerBooleanIs the member is owner or not?
member.is_moderatorBooleanIs the member a moderator or not?
member.is_blockedBooleanIs member account blocked status?
member.created_atStringAuto generated time and date on account creation
tokenStringMember auth token

Example

{
  "status": {
    "code": 200,
    "type": "success"
  },
  "member": {
    // Unique identifier for the object
    "member_id": 1,
    "first_name": "Mike",
    "last_name": "Hunt",
    "email_address": "email@example.com",
    "profile_picture": "https://www.example.com/image.jpg",
    "is_owner": true,
    "is_moderator": true,
    "is_blocked": false,
    "created_at": "2020-02-01T04:48:48.909Z"
  },
  "token": "token"
}