API Documentation
  • Getting Started
  • Changelog
  • Authentication
  • Date Format
  • Response API
  • Core Resources
    • Journal
    • Habits
      • Status
      • Logs
      • Goal
        • Periodicity
    • Actions List
    • Notes
    • Moods
    • Areas
  • Enum
    • Action Status
    • Mood Value
    • Note Type
    • Unit Type
    • Log Method
    • Time Of Day
Powered by GitBook
On this page

Was this helpful?

Response API

PreviousDate FormatNextJournal

Last updated 4 years ago

Was this helpful?

We wrapper all the response from our API by the generic class that has a format like this:

{
    "message": String,
    "data": T,
    "version": String,
    "status": Boolean
}

T is the dynamic type of data, depending on the API. For example, if you call our API to get a list of your habits, T represents the array of object.

If you failed when calling API, the message field will display the error message, and the status will be false.

Otherwise, the message field will be "Success" and the status will be true.

Habits