Notes

Properties

This table describes all properties of a Note object.

Name	Type	Required	Description
id	String	required
content	String	required
created_date	Date	required
habit_id	String	required
note_type	Number	required	Note Type
image_url	String	optional	Only different null if note_type is 2. See more: Note Type

List Notes

GET https://api.habitify.me/notes/:habit_id

Get all notes of the habit

Path Parameters

Name	Type	Description
habit_id	string	ID of habit

Query Parameters

Name	Type	Description
from	string	Date Format
to	boolean	Date Format

Headers

Name	Type	Description
Authorization	string	API Key

200 An array of Note object.

{
    "message": "Success",
    "data": [
        {
            "id": "-MakqEWlb6c6D7WOdPj6",
            "content": "Today is the first day of my journey",
            "created_date": "2021-05-28T09:40:53",
            "image_url": null,
            "note_type": 1,
            "habit_id": "94E9E907-81DB-4838-89BD-FECE283C6B10"
        }
    ],
    "version": "v1.2",
    "status": true
}

Add Text Note

POST https://api.habitify.me/notes/:habit_id

Append new note for specific habit

Path Parameters

Name	Type	Description
habit_id	string	The habit ID

Headers

Name	Type	Description
Authorization	string	API Key

Request Body

Name	Type	Description
created	string	Date Format
content	string	Content of the note you're adding

200

{
    "message": "Success",
    "data": null,
    "version": "v1.2",
    "status": true
}

402 You've reached the limits. Please upgrade the premium to enjoy unlimited usage.

Account Upgrade Required

{
    "message": "Upgrade to Premium to enjoy unlimited usage",
    "data": null,
    "version": "v1.2",
    "status": false
}

Add Image Note

POST https://api.habitify.me/notes/addImageNote/:habit_id

Path Parameters

Name	Type	Description
habit_id	string	​

Query Parameters

Name	Type	Description
created_at	string

Headers

Name	Type	Description
Authorization	string	API Key

Request Body

Name	Type	Description
image	object	Only support JPG, JPEG format. The size of the image is smaller than 2MB.

200 Success

{
    "message": "Success",
    "data": null,
    "version": "v1.2",
    "status": true
}

402 You've reached the limits. Please upgrade the premium to enjoy unlimited usage.

{
    "message": "Upgrade to Premium to enjoy unlimited usage",
    "data": null,
    "version": "v1.2",
    "status": false
}

500 Wrong format image or the size of the image is over 2MB

// Wrong format
{
    "message": "Only support JPEG/JPG type",
    "data": null,
    "version": "v1.2",
    "status": false
}
// Size over 2MB
{
    "message": "The maxium size of the image is 2MB",
    "data": null,
    "version": "v1.2",
    "status": false
}

Delete Note

DELETE https://api.habitify.me/notes/:habit_id/:note_id

Path Parameters

Name	Type	Description
note_id	string	Note ID
habit_id	string	Habit ID

Headers

Name	Type	Description
Authorization	string	API Key

200 Note deleted

{
    "message": "Success",
    "data": null,
    "version": "v1.2",
    "status": true
}

Delete Notes

DELETE https://api.habitify.me/notes/:habit_id

Path Parameters

Name	Type	Description
habit_id	string

Headers

Name	Type	Description
Authorization	string	API Key

Request Body

Name	Type	Description
to	string	Date Format
from	string	Date Format

200

{
    "message": "Success",
    "data": null,
    "version": "v1.2",
    "status": true
}