Skip to main content
GET
/
habits
Get list of habits
curl --request GET \
  --url https://production.api.onvy.health/habits \
  --header 'X-API-Key: <api-key>'
[
  {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_time": "2023-11-07T05:31:56Z",
    "last_edited_time": "2023-11-07T05:31:56Z",
    "archived": true,
    "in_trash": true,
    "url": "<string>",
    "playUnexpectedImpact": true,
    "category": "<string>",
    "playImpact": true,
    "title": "<string>",
    "description": "<string>",
    "cover": "<string>",
    "public_url": "<string>",
    "potentialImpacts": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Response

Successful response

​
name
string
required

The name identifier of the mindfulness activity

​
id
string<uuid>
required

Unique identifier for the activity

​
created_time
string<date-time>
required

ISO 8601 timestamp when the activity was created

​
last_edited_time
string<date-time>
required

ISO 8601 timestamp when the activity was last modified

​
archived
boolean
required

Whether the activity is archived

​
in_trash
boolean
required

Whether the activity is in trash

​
url
string<uri>
required

The primary URL for accessing the activity

​
playUnexpectedImpact
boolean
required

Whether to play unexpected impact animations or effects

​
category
string
required

The category classification of the activity

​
playImpact
boolean
required

Whether to play impact animations or effects

​
title
string
required

Human-readable title of the activity

​
description
string
required

Detailed description of the activity

​
cover
string<uri> | null

URL to the cover image for the activity

​
public_url
string<uri> | null

Public URL if the activity is publicly accessible

​
potentialImpacts
object

Object containing various impact categories and their details