Skip to main content
GET
Get all habits

Authorizations

X-API-Key
string
header
required

API key generated from our app (Settings > API). Only one key can be active at a time.

Query Parameters

archived
boolean

Filter by archived status. If true, returns only archived habits. If false, returns only active habits.

areaId
string

Filter by area ID to return only habits assigned to a specific area

type
enum<string>

Filter by habit type (good or bad) Indicates whether a habit is something you want to build or break. A "good" habit is one you want to maintain or increase (e.g., exercise, reading). A "bad" habit is one you want to reduce or eliminate (e.g., smoking, excessive screen time).

Available options:
good,
bad
timeOfDay
string

Filter by time-of-day period ID

limit
integer
default:50

Maximum number of habits to return per page

Required range: 1 <= x <= 100
offset
integer
default:0

Number of habits to skip for pagination

Required range: x >= 0

Response

A paginated list of habits

data
object[]
pagination
object