# Homeyscript API docs?

**URL:** <https://community.homey.app/t/homeyscript-api-docs/94828>\
**Category:** Questions & Help\
**Created:** [November 16, 2023, 3:38pm UTC](https://community.homey.app/t/homeyscript-api-docs/94828 "2023-11-16T15:38:54Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Bohington](https://sea1.discourse-cdn.com/flex025/user_avatar/community.homey.app/bohington/32/14593_2.png) [@Bohington](https://community.homey.app/u/Bohington)\
**Post date:** [November 16, 2023, 3:38pm UTC](https://community.homey.app/t/homeyscript-api-docs/94828/1 "2023-11-16T15:38:54Z")

</div>

Hi Ladies & gents

I started to explore the scripts capabilities of Homey  
I’ve started by looking at scripts examples in the WEB interface and started to play with JS examples provided.

for example, I spoted a script to collect all devices registered to Homey and do something with them  
I can see something like device.xxxxxx where xxxxxx is “id”, “name”,… or whatever  
I wonder if there is a documentation somewhere describing scripting capabilities, list of objects, list of method that can be used with their parameters, outputs, errorlog,… all what a programmer can need

for example, linked to devices, I can see a “repair”, that I suspect to be a method to heal that particular device but I’m not sure. better ask to you guys before to break something.

And again, my request is more generic to all what we can do rather than this specific question on healing

Best regards a thanks for your help.

---

<div class="post-metadata">

**Author:** ![robertklep](https://sea1.discourse-cdn.com/flex025/user_avatar/community.homey.app/robertklep/32/160628_2.png) [@robertklep](https://community.homey.app/u/robertklep)\
**Post date:** [November 16, 2023, 3:41pm UTC](https://community.homey.app/t/homeyscript-api-docs/94828/2 "2023-11-16T15:41:55Z")

</div>

> [@Bohington](#):
>
> I wonder if there is a documentation somewhere describing scripting capabilities, list of objects, list of method that can be used with their parameters, outputs, errorlog,… all what a programmer can need

HomeyScript uses the Web API, which is documented [here](https://athombv.github.io/node-homey-api/HomeyAPIV2.html).

There’s also a HomeyScript reference document [here](https://athombv.github.io/com.athom.homeyscript/global).

---

<div class="post-metadata">

**Author:** ![Rmb](https://sea1.discourse-cdn.com/flex025/user_avatar/community.homey.app/rmb/32/79135_2.png) [@Rmb](https://community.homey.app/u/Rmb)\
**Post date:** [November 16, 2023, 3:44pm UTC](https://community.homey.app/t/homeyscript-api-docs/94828/3 "2023-11-16T15:44:20Z")

</div>

One way of getting the object tree, is to start with the top object and get all its objects. And so on.